Skip to main content

EWS Snippets for PowerGui

Snippets are an idea that has been around in IDE environments for quite some time and can really be a time saver when it comes to writing EWS scripts. The following are the Snippets for PowerGUI that i presented in my MEC talk in September (Sorry I'm a little late in publishing these).

To use these snippits first you need to have powergui then you can download the Zip file that contains all the snippits from . 

Once you have unzipped the files to a directory run the ./installsnippits.ps1 script from this directory which will create a snippits folder under %UserName%\My Documents\WindowsPowerShell and copy the snippits into this directory.

Using the Snippits is pretty easy but you do need to understand a little bit about building EWS scripts. The majority of the EWS scripts you create will have 4 major phases

1st Phase - Is to connect and authenticate to the CAS server, in this day and age you should have a proper SSL certificate and Autodiscover should be configured.  So in this first phase you need to acquire from somewhere the SMTPAddress of the mailbox you want to access and credentials for you to use to access the mailbox. Then perform a Autodiscover using the SMTPAddress and credentials you acquired which should then return the URL for EWS.

I've bundled this phase into the following snippit

The snippit will take the SMTPAddress as a cmdline parameter

$MailboxName = $args[0]

And also grab the credentials from the user (make sure you use the UPN as the username when it prompts)

$psCred = Get-Credential 
$creds = New-Object System.Net.NetworkCredential($psCred.UserName.ToString(),$psCred.GetNetworkCredential().password.ToString()) 
$service.Credentials = $creds     

2nd Phase - Now you have the URL for the CAS server to send your EWS request to, the next step is to bind to the folder you want to work with. For all the WellKnownFolders you can bind using the WellKnownFolder enum. I've bundled this phase together in another snippit for each folder for example to bind to the Inbox you use

If you wanted to instead bind to a Subfolder or user created folder I have another snippit for this phase which will bind to a folder using a path.

3rd Phase - Once you have the Folderid of the Folder you want to work with you can then either work with that folder or work with the Items in that folder so the snippit to use if you wish to Enumerate All Folder Items is (there are also several example of searches)

 With this snippit you need to replace the $Folder.Id with the Folder.Id from the other Snippit eg if you used

$folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)  
$Inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)

You should then change

$fiItems = $service.FindItems($Folder.Id,$ivItemView)


$fiItems = $service.FindItems($Inbox.Id,$ivItemView)

4th Phase : There is no snippit for this but its basically where you put the code to process the Items eg you could output the Subject

    foreach($Item in $fiItems.Items){     

or any of the other things I've listed in my other Howto

That's it there are over 60 snippits altogether that I'll try to grow over time if you have any you want to include to help others out please send them to me and I'll include them.

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.