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

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  https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-

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  https://gscales.github.io/Graph-Powershell-101-Binder/   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  https://github.com/gscales/Powershell-Scripts/blob/master/Graph101/Dumpster.ps1

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.