Skip to main content

Using the EWS Managed API with powershell

If you missed it the first public beta of Exchange 2010 was released this week while I'm not one for getting two excited over beta's there was one other important release this week which was the beta release of the EWS Managed API. Why this is a little more exciting then a new version of Exchange is that you can actually start using this now to access Exchange Web Services on a Exchange 2007 Server. What makes this component a little more significant if you have done any programming in EWS even if it just sending raw XML to and from the server you may have noticed that at times this can be difficult and the interface isn't that intuitive. So what the EWS Managed API sets out to do is provide you with a interface that makes writing Exchange code a more intuitive experience by essential normalising the logic and the interfaces you use. While there are still some inescapable realities of writing Exchange code like Mapi properties etc (If you have missed them there has been some great posts recently on Mapi properties on the Exchange blog see) this is a much needed addition.

For anybody who wants to write simple Powershell scripts that access Exchange mailbox data your going to love this API. Lets look at how to get started and then you can start buring some daylight.

Requirments

The EWS Managed API requires the workstation where your running this from to have .NET 3.5 installed. The RTM version of Powershell will work fine with 3.5 so there's no need for V2. You then need to download and Install the EWS Managed API first from here

Coding

First you need to load the DLL

$dllpath = "C:\Program Files\Microsoft\Exchange\Web Services\1.0\Microsoft.Exchange.WebServices.dll"
[void][Reflection.Assembly]::LoadFile($dllpath)

Now you can create a ExchangeService object if your going to be coding against 2007 you must explictly set the version.

$service = new-object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2007_SP1)

Depending on where your running this code if you can make use of Autodiscover then all you need to do is provide the email address and the component will autodicover the CAS server to use. eg

$service.AutodiscoverUrl("email@domain.com")

You may not however want to hardcode the users email address in a script so what you might want to do is grab the email address using ADSI by using the Users SID eg.

$windowsIdentity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
$sidbind = "LDAP://<SID=" + $windowsIdentity.user.Value.ToString() + ">"
$aceuser = [ADSI]$sidbind

$service.AutodiscoverUrl($aceuser.mail.ToString())

If you can't use Autodiscover and you want to hardcode the URI then you could use

$uri=[system.URI] "https://casservername/ews/exchange.asmx"
$service.Url = $uri

If you dont want to use the currently logged on users credentials then you can specifiy your own
$service.Credentials = New-Object System.Net.NetworkCredential("username","password","domain")

You can also make use of Impersonation if you so wish but i haven't got a sample for that yet. But once you have connected and authenticated against EWS you can then use some simple code to do a varitety of things here one sample of showing the number of unread email and that last received email's details

$inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service, [Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox)
"Number or Unread Messages : " + $inbox.UnreadCount
$view = New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)
$findResults = $service.FindItems([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$view)
""
"Last Mail From : " + $findResults.Items[0].From.Name
"Subject : " + $findResults.Items[0].Subject
"Sent : " + $findResults.Items[0].DateTimeSent

If your running this against a development server that has self signed certificates then there is another thing you need to add to your code to make it capable of dealing with self signed certificates. Because you cant use delegates in the RTM version of Powershell you need to use a workaround there is this one or http://poshcode.org/624

For more samples have a look at Exchange development portal.

I've put a download of these scripts here
Labels:

Popular posts from this blog

The MailboxConcurrency limit and using Batching in the Microsoft Graph API

If your getting an error such as Application is over its MailboxConcurrency limit while using the Microsoft Graph API this post may help you understand why. Background   The Mailbox  concurrency limit when your using the Graph API is 4 as per https://docs.microsoft.com/en-us/graph/throttling#outlook-service-limits . This is evaluated for each app ID and mailbox combination so this means you can have different apps running under the same credentials and the poor behavior of one won't cause the other to be throttled. If you compared that to EWS you could have up to 27 concurrent connections but they are shared across all apps on a first come first served basis. Batching Batching in the Graph API is a way of combining multiple requests into a single HTTP request. Batching in the Exchange Mail API's EWS and MAPI has been around for a long time and its common, for email Apps to process large numbers of smaller items for a variety of reasons.  Batching in the Gr...
Read more

Sending a Message in Exchange Online via REST from an Arduino MKR1000

This is part 2 of my MKR1000 article, in this previous post  I looked at sending a Message via EWS using Basic Authentication.  In this Post I'll look at using the new Outlook REST API  which requires using OAuth authentication to get an Access Token. The prerequisites for this sketch are the same as in the other post with the addition of the ArduinoJson library  https://github.com/bblanchon/ArduinoJson  which is used to parse the Authentication Results to extract the Access Token. Also the SSL certificates for the login.windows.net  and outlook.office365.com need to be uploaded to the devices using the wifi101 Firmware updater. To use Token Authentication you need to register an Application in Azure https://msdn.microsoft.com/en-us/office/office365/howto/add-common-consent-manually  with the Mail.Send permission. The application should be a Native Client app that use the Out of Band Callback urn:ietf:wg:oauth:2.0:oob. You ...
Read more

How to test SMTP using Opportunistic TLS with Powershell and grab the public certificate a SMTP server is using

Most email services these day employ Opportunistic TLS when trying to send Messages which means that wherever possible the Messages will be encrypted rather then the plain text legacy of SMTP.  This method was defined in RFC 3207 "SMTP Service Extension for Secure SMTP over Transport Layer Security" and  there's a quite a good explanation of Opportunistic TLS on Wikipedia  https://en.wikipedia.org/wiki/Opportunistic_TLS .  This is used for both Server to Server (eg MTA to MTA) and Client to server (Eg a Message client like Outlook which acts as a MSA) the later being generally Authenticated. Basically it allows you to have a normal plain text SMTP conversation that is then upgraded to TLS using the STARTTLS verb. Not all servers will support this verb so if its not supported then a message is just sent as Plain text. TLS relies on PKI certificates and the administrative issue s that come around certificate management like expired certificates which is why ...
Read more
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.