Removing Proxy Addresses from Exchange Recipients

This script and the accompanying post have been updated.

I saw a request come through the other day for a method to remove unwanted proxy addresses for contacts.  I’d had some code sitting around from a project a few years back and decided to freshen it up, and maybe add some newer tricks.

So, the original idea was to select a bunch of users (Get-MailUser, Get-MailContact, etc) and then remove proxy addresses matching patterns.  And this works splendidly:

[array]$contacts = Get-MailContact -Resultsize Unlimited
ForEach($contact in $contacts)
{
Write-Host Processing $contact
For($i=($contact.EmailAddresses.count)-1; $i -ge 0; $i--)
{
$address=$contact.EmailAddresses[$i]
$addressString=$address.addressString.ToString()
If($addressString -like "*contoso.com*")
{
Write-Host -ForegroundColor Green Removing $addressString
$contact.EmailAddresses.removeat($i)
}
}
$contact|Set-MailContact -EmailAddresses $contact.EmailAddresses
}

But, what if there are a lot of address patterns that I want to remove?

We can just add an array of patterns to remove and a nested loop like this:

[array]$StringsToRemove = ('tailspintoys.ca','nwtraders.net','fabrikam.com')
[array]$contacts = Get-MailContact -Resultsize Unlimited

ForEach($contact in $contacts)
{
Write-Host Processing $contact
For($i=($contact.EmailAddresses.count)-1; $i -ge 0; $i--)
{
Foreach ($string in $StringsToRemove)
{
$address=$contact.EmailAddresses[$i]
$addressString=$address.addressString.ToString()
If($addressString -like "*$string*")
{
Write-Host -ForegroundColor Green "Removing $addressString"
$contact.EmailAddresses.removeat($i)
}
}
$contact | Set-MailContact -EmailAddresses $contact.EmailAddresses
}
}

But, Aaron, what if I want to do more than just contacts?  What if I want to remove the proxies from MailUsers, Mailboxes, AND/OR contacts?

Now we’re talking about a script.

PARAM(
[ValidateSet('Mailbox', 'MailUser', 'MailContact')]
[array]$RecipientTypes = @('Mailbox', 'MailUser', 'MailContact'),
[ValidatePattern("^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|[1-9][0-9][0-9][0-9][0-9]|[1-9][0-9][0-9][0-9][0-9][0-9]|Unlimited)$")]
[string]$ResultSize = "Unlimited",
[string]$Identity,
[array]$StringsToRemove
)

Foreach ($Type in $RecipientTypes)
{
Switch ($Type)
{
Mailbox
{
if ($Identity)
{
[array]$mailboxes = Get-Mailbox -Identity $Identity -wa SilentlyContinue -ea SilentlyContinue
}
else
{
[array]$mailboxes = Get-Mailbox -Resultsize $Resultsize -wa SilentlyContinue -ea Silently Continue
Write-Host "Procesing $($Resultsize) UserMailbox objects."
}
ForEach ($mailbox in $mailboxes)
{
Write-Host Processing $mailbox
For ($i = ($mailbox.EmailAddresses.count) - 1; $i -ge 0; $i--)
{
Foreach ($string in $StringsToRemove)
{
$address = $mailbox.EmailAddresses[$i]
$addressString = $address.addressString
If ($addressString -like "*$string*")
{
Write-Host -ForegroundColor Green "Removing $addressString"
$mailbox.EmailAddresses.removeat($i)
}
}
$mailbox | Set-Mailbox -EmailAddresses $mailbox.EmailAddresses
}
}
} # End Mailbox
MailUser
{
If ($Identity)
{
[array]$mailusers = Get-MailUser -Identity $Identity -wa SilentlyContinue -ea SilentlyContinue
}
else
{
[array]$mailusers = Get-MailUser -Resultsize $Resultsize -wa SilentlyContinue -ea SilentlyContinue
Write-Host "Processing $($Resultsize) MailUser objects."
}
ForEach ($mailuser in $mailusers)
{
Write-Host Processing $mailuser
For ($i = ($mailuser.EmailAddresses.count) - 1; $i -ge 0; $i--)
{
Foreach ($string in $StringsToRemove)
{
$address = $mailuser.EmailAddresses[$i]
$addressString = $address.addressString
If ($addressString -like "*$string*")
{
Write-Host -ForegroundColor Green "Removing $addressString"
$mailuser.EmailAddresses.removeat($i)
}
}
$mailuser | Set-Mailuser -EmailAddresses $mailuser.EmailAddresses
}
}
} # End MailUser
MailContact
{
If ($Identity)
{
[array]$contacts = Get-MailContact -Identity $Identity -wa SilentlyContinue -ea SilentlyContinue
}
else
{
[array]$contacts = Get-MailContact -Resultsize $Resultsize -wa SilentlyContinue -ea SilentlyContinue
Write-Host "Processing $($Resultsize) MailContact objects."
}
ForEach ($contact in $contacts)
{
Write-Host Processing $contact
For ($i = ($contact.EmailAddresses.count) - 1; $i -ge 0; $i--)
{
Foreach ($string in $StringsToRemove)
{
$address = $contact.EmailAddresses[$i]
$addressString = $address.addressString
If ($addressString -like "*$string*")
{
Write-Host -ForegroundColor Green "Removing $addressString"
$contact.EmailAddresses.removeat($i)
}
}
$contact | Set-MailContact -EmailAddresses $contact.EmailAddresses
}
}
} # End MailContact
} # End Switch
} # End Foreach $Type

Be fruitful and multip–er, remove!

You can get the completed script at https://gallery.technet.microsoft.com/Remove-Exchange-Proxy-eb5be217.