functions/contacts/Remove-EXCContact.ps1
|
function Remove-EXCContact { <# .SYNOPSIS Deletes a Contact in a Contact folder in a Mailbox using the Exchange Web Services API .DESCRIPTION Deletes a Contact in a Contact folder in a Mailbox using the Exchange Web Services API Requires the EWS Managed API from https://www.microsoft.com/en-us/download/details.aspx?id=42951 .PARAMETER MailboxName A description of the MailboxName parameter. .PARAMETER EmailAddress A description of the EmailAddress parameter. .PARAMETER Credentials A description of the Credentials parameter. .PARAMETER force A description of the force parameter. .PARAMETER Folder A description of the Folder parameter. .PARAMETER Partial A description of the Partial parameter. .EXAMPLE Example 1 To delete a contact from the default contacts folder Remove-EXCContact -MailboxName mailbox@domain.com -EmailAddress email@domain.com .EXAMPLE Example2 To delete a contact from a non user subfolder Remove-EXCContact -MailboxName mailbox@domain.com -EmailAddress email@domain.com -Folder \Contacts\Subfolder #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory = $true)] [string] $MailboxName, [Parameter(Position = 1, Mandatory = $true)] [string] $EmailAddress, [Parameter(Position = 2, Mandatory = $false)] [System.Management.Automation.PSCredential] $Credentials, [Parameter(Position = 3, Mandatory = $false)] [switch] $force, [Parameter(Position = 4, Mandatory = $false)] [string] $Folder, [Parameter(Position = 5, Mandatory = $false)] [switch] $Partial, [Parameter(Position = 6, Mandatory = $False)] [switch] $ModernAuth, [Parameter(Position = 7, Mandatory = $False)] [String] $ClientId ) Begin { #Connect $service = Connect-EXCExchange -MailboxName $MailboxName -Credential $Credentials -ModernAuth:$ModernAuth.IsPresent -ClientId $ClientId if ($useImpersonation.IsPresent) { $service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName) } $folderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Contacts, $MailboxName) if ($Folder) { $Contacts = Get-EXCContactFolder -Service $service -FolderPath $Folder -SmptAddress $MailboxName } else { $Contacts = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service, $folderid) } if ($service.URL) { $type = ("System.Collections.Generic.List" + '`' + "1") -as "Type" $type = $type.MakeGenericType("Microsoft.Exchange.WebServices.Data.FolderId" -as "Type") $ParentFolderIds = [Activator]::CreateInstance($type) $ParentFolderIds.Add($Contacts.Id) $Error.Clear(); $cnpsPropset = new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties) $ncCol = $service.ResolveName($EmailAddress, $ParentFolderIds, [Microsoft.Exchange.WebServices.Data.ResolveNameSearchLocation]::DirectoryThenContacts, $true, $cnpsPropset); if ($Error.Count -eq 0) { if ($ncCol.Count -eq 0) { Write-Host -ForegroundColor Yellow ("No Contact Found") } else { foreach ($Result in $ncCol) { if ($Result.Contact -eq $null) { $contact = [Microsoft.Exchange.WebServices.Data.Contact]::Bind($service, $Result.Mailbox.Id) if ($force) { if (($Result.Mailbox.Address.ToLower() -eq $EmailAddress.ToLower())) { $contact.Delete([Microsoft.Exchange.WebServices.Data.DeleteMode]::SoftDelete) Write-Host ("Contact Deleted " + $contact.DisplayName + " : Subject-" + $contact.Subject + " : Email-" + $Result.Mailbox.Address) } else { Write-Host ("This script won't allow you to force the delete of partial matches") } } else { if (($Result.Mailbox.Address.ToLower() -eq $EmailAddress.ToLower()) -bor $Partial.IsPresent) { $yes = New-Object System.Management.Automation.Host.ChoiceDescription "&Yes", "" $no = New-Object System.Management.Automation.Host.ChoiceDescription "&No", "" $choices = [System.Management.Automation.Host.ChoiceDescription[]]($yes, $no) $message = "Do you want to Delete contact with DisplayName " + $contact.DisplayName + " : Subject-" + $contact.Subject + " : Email-" + $Result.Mailbox.Address $result = $Host.UI.PromptForChoice($caption, $message, $choices, 1) if ($result -eq 0) { $contact.Delete([Microsoft.Exchange.WebServices.Data.DeleteMode]::SoftDelete) Write-Host ("Contact Deleted") } else { Write-Host ("No Action Taken") } } } } else { if ((Test-EmailAddress -EmailAddress $Result.Mailbox.Address)) { if ($Result.Mailbox.MailboxType -eq [Microsoft.Exchange.WebServices.Data.MailboxType]::Mailbox) { $UserDn = Get-UserDN -service $service -EmailAddress $Result.Mailbox.Address $cnpsPropset = new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties) $ncCola = $service.ResolveName($UserDn, $ParentFolderIds, [Microsoft.Exchange.WebServices.Data.ResolveNameSearchLocation]::ContactsOnly, $true, $cnpsPropset); if ($ncCola.Count -eq 0) { Write-Host -ForegroundColor Yellow ("No Contact Found") } else { Write-Host ("Number of matching Contacts Found " + $ncCola.Count) $rtCol = @() foreach ($aResult in $ncCola) { if (($aResult.Mailbox.Address.ToLower() -eq $EmailAddress.ToLower()) -bor $Partial.IsPresent) { $contact = [Microsoft.Exchange.WebServices.Data.Contact]::Bind($service, $aResult.Mailbox.Id) if ($force) { if ($aResult.Mailbox.Address.ToLower() -eq $EmailAddress.ToLower()) { $contact.Delete([Microsoft.Exchange.WebServices.Data.DeleteMode]::SoftDelete) Write-Host ("Contact Deleted " + $contact.DisplayName + " : Subject-" + $contact.Subject + " : Email-" + $Result.Mailbox.Address) } else { Write-Host ("This script won't allow you to force the delete of partial matches") } } else { $yes = New-Object System.Management.Automation.Host.ChoiceDescription "&Yes", "" $no = New-Object System.Management.Automation.Host.ChoiceDescription "&No", "" $choices = [System.Management.Automation.Host.ChoiceDescription[]]($yes, $no) $message = "Do you want to Delete contact with DisplayName " + $contact.DisplayName + " : Subject-" + $contact.Subject + " : Email-" + $Result.Mailbox.Address $result = $Host.UI.PromptForChoice($caption, $message, $choices, 1) if ($result -eq 0) { $contact.Delete([Microsoft.Exchange.WebServices.Data.DeleteMode]::SoftDelete) Write-Host ("Contact Deleted ") } else { Write-Host ("No Action Taken") } } } else { Write-Host ("Skipping Matching because email address doesn't match address on match " + $aResult.Mailbox.Address.ToLower()) } } } } } else { Write-Host -ForegroundColor Yellow ("Email Address is not valid for GAL match") } } } } } } } } |