EWSContacts: Removing a Contact's phone number using EWS in Powershell?

[grahamr975]

Hello,

Could you please provide some guidance on how I could strip a contact object's phone/mobile number in Powershell EWS? Setting it to $null does not work. I understand that the BusinessPhone/MobilePhone is an extended property and that there is a special way it has to be removed. I tried going through the EWS extended property list documentation, but become somewhat lost.

See below for what I'm looking for. Any help would be greatly appreciated.

if ($BusinssPhone -ne "")
{
	$Contact.PhoneNumbers[[Microsoft.Exchange.WebServices.Data.PhoneNumberKey]::BusinessPhone] = $BusinssPhone
} else {
	$Contact.PhoneNumbers[[Microsoft.Exchange.WebServices.Data.PhoneNumberKey]::BusinessPhone] = $NULL
}

[gscales]

You need to do something like https://learn.microsoft.com/en-us/previous-versions/office/developer/exchange-server-2010/jj585538(v=exchg.80) . So you need to define the properties bind to the item with that definition and then use the RemoveExtendedProperty method then update the item which should then generate the correct EWS operations. (Make sure you do all the step else it won't work correctly).

eg

$Email1DisplayName = New-Object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition([Microsoft.Exchange.WebServices.Data.DefaultExtendedPropertySet]::Address,0x8080,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);

etc

[grahamr975]

@gscales

Thanks for your help. I ended up figuring this out. The missing piece is that you have to bind the extended properties to the contact at the time of the object's creation or they will fail to remove each time.

Fetching the contacts from the user's folder. Now it adds the extended properties for the Telephone & Mobile phone with the First Class properties list when each contact object is generated.

$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName)
$psPropset = new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)

### Add the extended properties for the business and mobile phone so they can be removed later if needed
$PidTagBusinessTelephoneNumber = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x3A08,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);
$PidTagMobileTelephoneNumber = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x3A1C,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);
$psPropset.Add($PidTagBusinessTelephoneNumber)
$psPropset.Add($PidTagMobileTelephoneNumber)
###

Remove the Telephone & Mobile if they're not present

if ($BusinssPhone -and $BusinssPhone -ne "")
{
	$Contact.PhoneNumbers[[Microsoft.Exchange.WebServices.Data.PhoneNumberKey]::BusinessPhone] = $BusinssPhone
} else {
	Write-Host "Removing Business Telephone..."
	# https://interoperability.blob.core.windows.net/files/MS-OXPROPS/%5bMS-OXPROPS%5d.pdf
	$PidTagBusinessTelephoneNumber = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x3A08,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);
	$Contact.RemoveExtendedProperty($PidTagBusinessTelephoneNumber)
}
if ($MobilePhone -and $MobilePhone -ne "")
{
	$Contact.PhoneNumbers[[Microsoft.Exchange.WebServices.Data.PhoneNumberKey]::MobilePhone] = $MobilePhone
} else {
	Write-Host "Removing Mobile Telephone..."
	# https://interoperability.blob.core.windows.net/files/MS-OXPROPS/%5bMS-OXPROPS%5d.pdf
	$PidTagMobileTelephoneNumber = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x3A1C,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);
	$Contact.RemoveExtendedProperty($PidTagMobileTelephoneNumber)
}