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 = "skippy@acme.com"
$EmailAddress1 = "skippy@acme.com"
$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 = "www.skipshelis.com"
$Department = "Flying"
$OfficeLocation = "1st Floor"
$Profession = "Pilot"

$soapString = "<?xml version=`"1.0`" encoding=`"utf-8`" ?> `
<soap:Envelope xmlns:soap=`"http://schemas.xmlsoap.org/soap/envelope/`"
xmlns:xsi=`"http://www.w3.org/2001/XMLSchema-instance`" `
xmlns:xsd=`"http://www.w3.org/2001/XMLSchema`">`
<soap:Header>`
<RequestServerVersion Version=`"Exchange2007_SP1`" xmlns=`"http://schemas.microsoft.com/exchange/services/2006/types`"
/> `
</soap:Header>`
<soap:Body> `
<CreateItem MessageDisposition=`"SaveOnly`" xmlns=`"http://schemas.microsoft.com/exchange/services/2006/messages`">`
<SavedItemFolderId> `
<DistinguishedFolderId Id=`"contacts`" xmlns=`"http://schemas.microsoft.com/exchange/services/2006/types`"
/>`
</SavedItemFolderId>`
<Items>`
<Contact xmlns=`"http://schemas.microsoft.com/exchange/services/2006/types`"> `
<Subject>" + $subject + "</Subject> `
<ExtendedProperty>`
<ExtendedFieldURI PropertySetId=`"00062004-0000-0000-C000-000000000046`"
PropertyId=`"32898`" PropertyType=`"String`" /> `
<Value>SMTP</Value> `
</ExtendedProperty>`
<ExtendedProperty>`
<ExtendedFieldURI PropertySetId=`"00062004-0000-0000-C000-000000000046`"
PropertyId=`"32896`" PropertyType=`"String`" /> `
<Value>" + $EmailDisplayAS + "</Value> `
</ExtendedProperty>`
<ExtendedProperty>`
<ExtendedFieldURI PropertySetId=`"00062004-0000-0000-C000-000000000046`"
PropertyId=`"32900`" PropertyType=`"String`" /> `
<Value>" + $EmailDisplayName + "</Value> `
</ExtendedProperty>`
<FileAs>" + $fileas + "</FileAs> `
<GivenName>" + $givenName + "</GivenName> `
<MiddleName>" + $middleName + "</MiddleName> `
<Nickname>" + $nickName + "</Nickname> `
<CompanyName>" + $CompanyName + "</CompanyName> `
<EmailAddresses>`
<Entry Key=`"EmailAddress1`">" + $EmailAddress1 + "</Entry> `
</EmailAddresses>`
<PhysicalAddresses>`
<Entry Key=`"Home`">`
<Street>" + $HomeStreet + "</Street> `
<City>" + $HomeCity + "</City> `
<State>" + $HomeState + "</State> `
<CountryOrRegion>" + $HomeCountry + "</CountryOrRegion> `
<PostalCode>" + $HomePostCode + "</PostalCode> `
</Entry>`
<Entry Key=`"Business`">
<Street>" + $BusinessStreet + "</Street> `
<City>" + $BusinessCity + "</City> `
<State>" + $BusinessState + "</State> `
<CountryOrRegion>" + $BusinessCountry + "</CountryOrRegion> `
<PostalCode>" + $BusinessPostCode + "</PostalCode> `
</Entry>`
</PhysicalAddresses>`
<PhoneNumbers>`
<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> `
</PhoneNumbers>`
<AssistantName>" + $AssistantName + "</AssistantName> `
<BusinessHomePage>" + $BusinessWebPage + "</BusinessHomePage> `
<Department>" + $Department + "</Department> `
<OfficeLocation>" + $OfficeLocation + "</OfficeLocation> `
<Profession>" + $Profession + "</Profession> `
<Surname>" + $Surname + "</Surname> `
</Contact>`
</Items>`
</CreateItem>`
</soap:Body>`
</soap:Envelope>"

$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)
$RequestStream.Close()
$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 {
$textresult
}

Popular posts from this blog

Export calendar Items to a CSV file using EWS and Powershell

Somebody asked about this last week and while I have a lot of EWS scripts that do access the Calendar I didn't have a simple example that just exported a list of the Calendar events with relevant information to a CSV file so here it is.

I've talked on this one before in this howto  but when you query the calendar folder using EWS you need to use a CalendarView which will expand any recurring appointments in a calendar. There are some limits when you use a calendarview in that you can only return a maximum of 2 years of appointments at a time and paging will limit the max number of items to 1000 per call. So if you have a calendar with a very large number of appointments you need to break your query into small date time blocks. In this example script I'm just grabbing the next 7 days of appointments if you want to query a longer period you need to adjust the following lines (keeping in mind what I just mentioned)

#Define Date to Query
$StartDate = (Get-Date)
$EndDate = (Ge…

EWS Managed API and Powershell How-To series Part 1

I thought I'd start the year with a series of posts that goes back over the basics of using the EWS Managed API from Powershell and provides a modular remarked example that you can easily cut and paste to build your own scripts. Along the way in this series I'll show a whole bunch of examples around specific things.

As a starting point for versions this will be Powershell Version 2.0  and the EWS Managed API 1.1 (which will soon change to 1.2 once released) http://www.microsoft.com/download/en/details.aspx?id=13480.

The starting point for any EWS script your going to write is connecting to Exchange for which there are three important pieces of information you will need. Firstly you need to know the version of Exchange your running in this script its going to be held in the following variable

$ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP1

Other valid values for Exchange 2007 would be

$ExchangeVersion = [Microsoft.Exchange.WebServices.…

Writing a simple scripted process to download attachmentts in Exchange 2007/ 2010 using the EWS Managed API

Every complicated thing in life is made up of smaller simpler building blocks, when it comes to writing a script (or any code really) the more of these little building blocks you have to figure out the more the process of solving a problem can become bewildering. The Internet generally provides you with lots of half eaten sandwiches of information something someone else has taken a bite out but a lot of the time half done, and as with any code its usefulness declines over time as new and better API's and methods are derived. In this post I'm going to go through a simple scripted process that hopefully covers a few more of these smaller building blocks that you might face when asked to come up with a simple costless solution to perform an automated business function with a script.

So the process im going to look at is one that comes up a lot and that is you have an Email that comes into to certain mailbox every day with a certain subject in my case "Daily Export" this …
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.