Skip to main content

Creating an Out of Office Board using Remote Powershell, Mailtips and the EWS Managed API

Following on from my previous post on using MailTips and one of my other popular posts the FreeBusy board the following script creates an Out of office board that shows in one page peoples out of office status and if the out of office message is turned on it displays the OOF message for that user.Here's a quick picture of what it produces


So how does it work it takes advantage of MailTips within EWS to get the OOF status of a user and what the OOF message is if its set. If you have a large number of users it batches the MailTips request in batches of 100 to ensure the request is successful. To get the list of users to query it takes advantage of using Remote powershell and uses the Get-Mailbox cmdlet.

The following script is setup to work with Office365 but will work OnPremise as well if change around the remote powershell URL.

The following variables are those that need to be configured to run this script

$UserName = "user@domain.com"
$Password = "password"

This is the username and password to use for both the remote powershell connection and it will also be used in the EWS Connection.

$MailboxName = $UserName

This line is setting the Sender email Address for MailTips to the above username if your using UPN's that are different from your SMTP addresses then you will need to change this variable.

$rpRemotePowershell = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.outlook.com/powershell -credential $adminCredential  -Authentication Basic -AllowRedirection

If your using this in a OnPrem environment then you need to change the URL and auth to suit your environment currently this is setup to connect to Office365.

I've put a download of this script here the script itself looks like

  1. $UserName = "user@domain.com"  
  2. $Password = "pasdfawrd."  
  3. $mbHash = @{ }  
  4. $MailboxName = $UserName  
  5.   
  6. $batchSize = 100  
  7. $global:oaBoard = ""  
  8.   
  9. $Mailboxes = @()  
  10.   
  11. $cred = New-Object System.Net.NetworkCredential($UserName,$Password)     
  12. $secpassword = ConvertTo-SecureString $Password -AsPlainText -Force  
  13. $adminCredential = New-Object -TypeName System.Management.Automation.PSCredential -argumentlist $UserName,$secpassword     
  14.   
  15. If(Get-PSSession | where-object {$_.ConfigurationName -eq "Microsoft.Exchange"}){  
  16.     write-host "Session Exists"  
  17. }  
  18. else{  
  19.     $rpRemotePowershell = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.outlook.com/powershell -credential $adminCredential  -Authentication Basic -AllowRedirection   
  20.     $importresults = Import-PSSession $rpRemotePowershell   
  21. }   
  22.   
  23. get-mailbox -ResultSize unlimited | where-object {$_.HiddenFromAddressListsEnabled -eq $false}  | foreach-object{  
  24.     if ($mbHash.ContainsKey($_.WindowsEmailAddress.ToString()) -eq $false){  
  25.         $mbHash.Add($_.WindowsEmailAddress.ToString(),$_.DisplayName)  
  26.           
  27.     }  
  28.     $emailAddress = $_.WindowsEmailAddress.ToString()  
  29.     $Mailboxes += $emailAddress  
  30. }  
  31.   
  32. $dllpath = "C:\Program Files\Microsoft\Exchange\Web Services\1.1\Microsoft.Exchange.WebServices.dll"  
  33. [void][Reflection.Assembly]::LoadFile($dllpath)  
  34. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP1)  
  35. $service.TraceEnabled = $false  
  36.   
  37. $service.Credentials = $cred  
  38. $service.autodiscoverurl($MailboxName,{$true})  
  39.   
  40. function GetMailTips{  
  41. $mbMailboxFolderURI = New-Object System.Uri($service.url)  
  42. $wrWebRequest = [System.Net.WebRequest]::Create($mbMailboxFolderURI)  
  43. $wrWebRequest.CookieContainer =  New-Object System.Net.CookieContainer
  44. $wrWebRequest.KeepAlive = $false;  
  45. $wrWebRequest.Headers.Set("Pragma""no-cache");  
  46. $wrWebRequest.Headers.Set("Translate""f");  
  47. $wrWebRequest.Headers.Set("Depth""0");  
  48. $wrWebRequest.ContentType = "text/xml";  
  49. $wrWebRequest.ContentLength = $expRequest.Length;  
  50. $wrWebRequest.Timeout = 60000;  
  51. $wrWebRequest.Method = "POST";  
  52. $wrWebRequest.Credentials = $cred  
  53. $bqByteQuery = [System.Text.Encoding]::ASCII.GetBytes($expRequest);  
  54. $wrWebRequest.ContentLength = $bqByteQuery.Length;  
  55. $rsRequestStream = $wrWebRequest.GetRequestStream();  
  56. $rsRequestStream.Write($bqByteQuery, 0, $bqByteQuery.Length);  
  57. $rsRequestStream.Close();  
  58. $wrWebResponse = $wrWebRequest.GetResponse();  
  59. $rsResponseStream = $wrWebResponse.GetResponseStream()  
  60. $sr = new-object System.IO.StreamReader($rsResponseStream);  
  61. $rdResponseDocument = New-Object System.Xml.XmlDocument  
  62. $rdResponseDocument.LoadXml($sr.ReadToEnd());  
  63. $RecipientNodes = @($rdResponseDocument.getElementsByTagName("t:RecipientAddress"))  
  64. $Datanodes = @($rdResponseDocument.getElementsByTagName("t:OutOfOffice"))  
  65. for($ic=0;$ic -lt $RecipientNodes.length;$ic++){  
  66.     if($Datanodes[$ic].ReplyBody.Message -eq ""){  
  67.           
  68.         $global:oaBoard = $global:oaBoard + "<tr>"  + "`r`n"  
  69.         $global:oaBoard = $global:oaBoard + "<td>" + $mbHash[$RecipientNodes[$ic].EmailAddress] + "</td>"  + "`r`n"  
  70.         $global:oaBoard = $global:oaBoard + "<td bgcolor=`"#41A317`">In the Office</td>"  + "`r`n"  
  71.         $global:oaBoard = $global:oaBoard + "<td></td>"  + "`r`n"  
  72.         $global:oaBoard = $global:oaBoard + "</tr>"  + "`r`n"  
  73.     }  
  74.     else{  
  75.         $global:oaBoard = $global:oaBoard + "<tr>"  + "`r`n"  
  76.         $global:oaBoard = $global:oaBoard + "<td>" + $mbHash[$RecipientNodes[$ic].EmailAddress] + "</td>"  + "`r`n"  
  77.         $global:oaBoard = $global:oaBoard + "<td bgcolor=`"#153E7E`">Out of the Office</td>"  + "`r`n"  
  78.         $global:oaBoard = $global:oaBoard + "<td>" + $Datanodes[$ic].ReplyBody.Message  + "</td>" + "`r`n"  
  79.         $global:oaBoard = $global:oaBoard + "</tr>"  + "`r`n"  
  80.     }  
  81. }  
  82. }  
  83.   
  84.   
  85. $expHeader = @" 
  86. <?xml version="1.0" encoding="utf-8"?> 
  87. <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">  
  88. <soap:Header><RequestServerVersion Version="Exchange2010_SP1" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" />  
  89. </soap:Header>  
  90. <soap:Body>  
  91. <GetMailTips xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">  
  92. <SendingAs>  
  93. <EmailAddress xmlns="http://schemas.microsoft.com/exchange/services/2006/types">$MailboxName</EmailAddress>  
  94. </SendingAs>  
  95. <Recipients>  
  96. "@  
  97.   
  98. $global:oaBoard = $global:oaBoard + "<table><tr bgcolor=`"#95aedc`">" +"`r`n"  
  99. $global:oaBoard = $global:oaBoard + "<td align=`"center`" style=`"width=200;`" ><b>User</b></td>" +"`r`n"  
  100. $global:oaBoard = $global:oaBoard + "<td align=`"center`" style=`"width=200;`" ><b>Status</b></td>" +"`r`n"  
  101. $global:oaBoard = $global:oaBoard + "<td align=`"center`" style=`"width=200;`" ><b>Message</b></td>" +"`r`n"  
  102. $global:oaBoard = $global:oaBoard + "</tr>" + "`r`n"  
  103.   
  104. $expRequest = $expHeader  
  105.   
  106. $bCount =0  
  107. foreach($mbMailbox in $Mailboxes){  
  108.     $bCount++  
  109.     $expRequest = $expRequest + "<Mailbox xmlns=`"http://schemas.microsoft.com/exchange/services/2006/types`"><EmailAddress>$mbMailbox</EmailAddress></Mailbox>"   
  110.     if($bCount -eq $batchSize){  
  111.         $expRequest = $expRequest + "</Recipients><MailTipsRequested>OutOfOfficeMessage</MailTipsRequested></GetMailTips></soap:Body></soap:Envelope>"  
  112.         GetMailTips  
  113.         $expRequest = $expHeader  
  114.         $bCount = 0  
  115.     }  
  116. }  
  117. if($bCount -ne 0){  
  118.     $expRequest = $expRequest + "</Recipients><MailTipsRequested>OutOfOfficeMessage</MailTipsRequested></GetMailTips></soap:Body></soap:Envelope>"  
  119.     GetMailTips  
  120. }  
  121. $global:oaBoard = $global:oaBoard + "</table>"  + "  "   
  122. $global:oaBoard | out-file "c:\oofboard.htm"  

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.