Skip to main content

Creating a Contact with Exchange Web Services from Powershell

The following is a script that demonstrates how to create a contact using a SOAP string and a simple web request. While this is not a very elegant solution as long as you have your SSL certs sorted out it should work okay. I was planning something a little cooler but time is really short at moment but this is still okay though. When creating a contact there are a few properties that you should set to get a fully working contact object. So the first part of the script is divided into required props which if you are using this in a pipeline you should always make sure you set. If you don’t you may find things like your contacts don’t appear properly when you try to use the contact in the Outlook Address book. The rest of the properties are optional which you can set if you have the information. This is not a complete list of contact properties that can be set within EWS just the majority of the most common ones for a full list please refer to the Exchange SDK. The big advantage if you’re using scripting with EWS in Powershell compared to VBS. is if you combine this script with some simple Import-csv code you can basically create contacts with in a mailbox from any properly formatted CSV (no matter where it came from).

The changeable part of this script is the credential section which allows you to specify the credentials to use when connecting to EWS if you don’t want to specify the credentials you can comment out the following lines

$unUserName = "username"
$psPassword = "password"
$dnDomainName = "domain"
$cdUsrCredentials = new-object System.Net.NetworkCredential($unUserName , $psPassword , $dnDomainName)

To change the script to use the currently logged on user credentials you need to change the following lines

# $WDRequest.Credentials = $cdUsrCredentials
$WDRequest.UseDefaultCredentials = $True

The only other thing you may want to change is to make the script use impersonation if you want to create contacts in mailboxes other than the one associated with the security credentials you are using. The impersonation header should be something like

<t:ExchangeImpersonation> `
<t:ConnectingSID> `
<t:SID>" + $siSIDToSearch.SID + "</t:SID> `
</t:ConnectingSID>" `
</t:ExchangeImpersonation>" `

I’ve put a downloadable copy of the script here the script itself looks like

#Required Props
$subject = "Skippy(Skippys Email)"
$EmailDisplayAS = "Skippy Roo(Skippys Emaill)"
$EmailDisplayName = ""
$EmailAddress1 = ""
$FileAs = "Roo, Skippy"

#Optional Props

$givenName = "Skippy"
$middleName = "The"
$Surname = "Roo"
$nickName = "Skip"
$CompanyName = "Skips Helicopters"
$HomeStreet = "32 Walaby Street"
$HomeCity = "Maroobra"
$HomeState = "NSW"
$HomeCountry = "Australia"
$HomePostCode = "2000"
$BusinessStreet = "45 Emu Place"
$BusinessCity = "Woolloomooloo"
$BusinessState = "NSW"
$BusinessCountry = "Australia"
$BusinessPostCode = "2000"
$HomePhone = "9999-99999"
$HomeFax = "9999-99999"
$BusinessPhone = "9999-99999"
$BusinessFax = "9999-99999"
$MobilePhone = "999-9999-99999"
$AssistantName = "Wally"
$BusinessWebPage = ""
$Department = "Flying"
$OfficeLocation = "1st Floor"
$Profession = "Pilot"

$soapString = "<?xml version=`"1.0`" encoding=`"utf-8`" ?> `
<soap:Envelope xmlns:soap=`"`"
xmlns:xsi=`"`" `
<RequestServerVersion Version=`"Exchange2007_SP1`" xmlns=`"`"
/> `
<soap:Body> `
<CreateItem MessageDisposition=`"SaveOnly`" xmlns=`"`">`
<SavedItemFolderId> `
<DistinguishedFolderId Id=`"contacts`" xmlns=`"`"
<Contact xmlns=`"`"> `
<Subject>" + $subject + "</Subject> `
<ExtendedFieldURI PropertySetId=`"00062004-0000-0000-C000-000000000046`"
PropertyId=`"32898`" PropertyType=`"String`" /> `
<Value>SMTP</Value> `
<ExtendedFieldURI PropertySetId=`"00062004-0000-0000-C000-000000000046`"
PropertyId=`"32896`" PropertyType=`"String`" /> `
<Value>" + $EmailDisplayAS + "</Value> `
<ExtendedFieldURI PropertySetId=`"00062004-0000-0000-C000-000000000046`"
PropertyId=`"32900`" PropertyType=`"String`" /> `
<Value>" + $EmailDisplayName + "</Value> `
<FileAs>" + $fileas + "</FileAs> `
<GivenName>" + $givenName + "</GivenName> `
<MiddleName>" + $middleName + "</MiddleName> `
<Nickname>" + $nickName + "</Nickname> `
<CompanyName>" + $CompanyName + "</CompanyName> `
<Entry Key=`"EmailAddress1`">" + $EmailAddress1 + "</Entry> `
<Entry Key=`"Home`">`
<Street>" + $HomeStreet + "</Street> `
<City>" + $HomeCity + "</City> `
<State>" + $HomeState + "</State> `
<CountryOrRegion>" + $HomeCountry + "</CountryOrRegion> `
<PostalCode>" + $HomePostCode + "</PostalCode> `
<Entry Key=`"Business`">
<Street>" + $BusinessStreet + "</Street> `
<City>" + $BusinessCity + "</City> `
<State>" + $BusinessState + "</State> `
<CountryOrRegion>" + $BusinessCountry + "</CountryOrRegion> `
<PostalCode>" + $BusinessPostCode + "</PostalCode> `
<Entry Key=`"HomePhone`">" + $HomePhone + "</Entry> `
<Entry Key=`"HomeFax`">" + $HomeFax + "</Entry> `
<Entry Key=`"BusinessPhone`">" + $BusinessPhone + "</Entry> `
<Entry Key=`"BusinessFax`">" + $BusinessFax + "</Entry> `
<Entry Key=`"MobilePhone`">" + $MobilePhone + "</Entry> `
<AssistantName>" + $AssistantName + "</AssistantName> `
<BusinessHomePage>" + $BusinessWebPage + "</BusinessHomePage> `
<Department>" + $Department + "</Department> `
<OfficeLocation>" + $OfficeLocation + "</OfficeLocation> `
<Profession>" + $Profession + "</Profession> `
<Surname>" + $Surname + "</Surname> `

$unUserName = "username"
$psPassword = "password"
$dnDomainName = "domain"
$cdUsrCredentials = new-object System.Net.NetworkCredential($unUserName ,
$psPassword , $dnDomainName)

$mbURI = "https://servername/EWS/Exchange.asmx"

$WDRequest = [System.Net.WebRequest]::Create($mbURI)
$WDRequest.ContentType = "text/xml"
$WDRequest.Headers.Add("Translate", "F")
$WDRequest.Method = "POST"
$WDRequest.Credentials = $cdUsrCredentials
# $WDRequest.UseDefaultCredentials = $True
$bytes = [System.Text.Encoding]::UTF8.GetBytes($soapString)
$WDRequest.ContentLength = $bytes.Length
$RequestStream = $WDRequest.GetRequestStream()
$RequestStream.Write($bytes, 0, $bytes.Length)
$WDResponse = $WDRequest.GetResponse()
$ResponseStream = $WDResponse.GetResponseStream()
$readStream = new-object System.IO.StreamReader $ResponseStream
$textresult = $readStream.ReadToEnd()
if ($textresult.indexofany("ResponseClass=`"Success`"")){
"Contact Created Sucessfully"
else {

Popular posts from this blog

Testing and Sending email via SMTP using Opportunistic TLS and oAuth in Office365 with PowerShell

As well as EWS and Remote PowerShell (RPS) other mail protocols POP3, IMAP and SMTP have had OAuth authentication enabled in Exchange Online (Official announcement here ). A while ago I created  this script that used Opportunistic TLS to perform a Telnet style test against a SMTP server using SMTP AUTH. Now that oAuth authentication has been enabled in office365 I've updated this script to be able to use oAuth instead of SMTP Auth to test against Office365. I've also included a function to actually send a Message. Token Acquisition  To Send a Mail using oAuth you first need to get an Access token from Azure AD there are plenty of ways of doing this in PowerShell. You could use a library like MSAL or ADAL (just google your favoured method) or use a library less approach which I've included with this script . Whatever way you do this you need to make sure that your application registration

How to access and restore deleted Items (Recoverable Items) in the Exchange Online Mailbox dumpster with the Microsoft Graph API and PowerShell

As the information on how to do this would cover multiple posts, I've bound this into a series of mini post docs in my GitHub Repo to try and make this subject a little easier to understand and hopefully navigate for most people.   The Binder index is   The topics covered are How you can access the Recoverable Items Folders (and get the size of these folders)  How you can access and search for items in the Deletions and Purges Folders and also how you can Export an item to an Eml from that folder How you can Restore a Deleted Item back to the folder it was deleted from (using the Last Active Parent FolderId) and the sample script is located

Using the MSAL (Microsoft Authentication Library) in EWS with Office365

Last July Microsoft announced here they would be disabling basic authentication in EWS on October 13 2020 which is now a little over a year away. Given the amount of time that has passed since the announcement any line of business applications or third party applications that you use that had been using Basic authentication should have been modified or upgraded to support using oAuth. If this isn't the case the time to take action is now. When you need to migrate a .NET app or script you have using EWS and basic Authentication you have two Authentication libraries you can choose from ADAL - Azure AD Authentication Library (uses the v1 Azure AD Endpoint) MSAL - Microsoft Authentication Library (uses the v2 Microsoft Identity Platform Endpoint) the most common library you will come across in use is the ADAL libraries because its been around the longest, has good support across a number of languages and allows complex authentications scenarios with support for SAML etc. The
All sample scripts and source code is provided by for illustrative purposes only. All examples are untested in different environments and therefore, I cannot guarantee or imply reliability, serviceability, or function of these programs.

All code contained herein is provided to you "AS IS" without any warranties of any kind. The implied warranties of non-infringement, merchantability and fitness for a particular purpose are expressly disclaimed.