Monday, November 28, 2011

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"  

Tuesday, November 08, 2011

Using MailTips in EWS to get the OOF (Out of Office) Status of users with C# and Powershell

MailTips is one of the really useful new features of Exchange 2010 that can be exceedingly useful to anybody using Exchange Web Services. It provides access to Information such as the OOF status of a user or users within one WebService call and without the need for Full Access or elevated rights you would normally need with a GetUserOofSettings operations or using the Remote powershell cmdlets such as Get-MailboxAutoReplyConfiguration.

The other thing MailTips are useful for apart from the other standard Mail-tips listed http://msdn.microsoft.com/en-us/library/dd877060%28v=exchg.140%29.aspx (things like the Max message size is useful for anybody sending email via EWS etc)  is the ability to create Custom MailTips. This gives you the ability to now retrieve a custom property that is stored within Active Directory via EWS. Which provides a workaround to not being able to access the information in the AD Custom Attributes http://technet.microsoft.com/en-us/library/ee423541.aspx currently in EWS.

To use the EWS Mailtips operations you need to use WSDL Proxy objects or Custom SOAP code as currently these operations aren't available for use within the EWS Managed API. If you want to script it I would still combine it with EWS Managed API code because of ease of access to things like Autodiscover this gives you.

I've created a powershell and C# sample of using the GetMailtips operation the C# looks like


  1. ExchangeServiceBinding esb = new ExchangeServiceBinding();   
  2. esb.Credentials = new NetworkCredential("user@domain.com""password""");   
  3. esb.Url = "https://ch1prd0302.outlook.com/EWS/Exchange.asmx";   
  4. esb.RequestServerVersionValue = new RequestServerVersion();   
  5. esb.RequestServerVersionValue.Version = ExchangeVersionType.Exchange2010_SP1;   
  6. GetMessageTrackingReportRequestType gmt = new GetMessageTrackingReportRequestType();   
  7. GetMailTipsType gmType = new GetMailTipsType();   
  8. gmType.MailTipsRequested = new MailTipTypes();   
  9. gmType.MailTipsRequested = MailTipTypes.OutOfOfficeMessage;   
  10. gmType.Recipients = new EmailAddressType[1];   
  11. EmailAddressType rcip = new EmailAddressType();   
  12. rcip.EmailAddress = "user@domain.com";   
  13. gmType.Recipients[0] = rcip;   
  14. EmailAddressType sendAs = new EmailAddressType();   
  15. sendAs.EmailAddress = "sender@domain.com";   
  16. gmType.SendingAs = sendAs;   
  17.   
  18. GetMailTipsResponseMessageType gmResponse = esb.GetMailTips(gmType);   
  19. if (gmResponse.ResponseClass == ResponseClassType.Success) {   
  20.     if (gmResponse.ResponseMessages[0].MailTips.OutOfOffice.ReplyBody.Message != "")   
  21.     {   
  22.         //User Out   
  23.         Console.WriteLine(gmResponse.ResponseMessages[0].MailTips.OutOfOffice.ReplyBody.Message);   
  24.     }   
  25.     else {    
  26.         //user In   
  27.     }   
  28.                      
  29. }  
With the Powershell example the following information needs to be configured

$MailboxName = "sender@domain.com"

Mailbox which will do the check from
 
$Mailboxes = @("user1@domain.com","user2@domain.com")

Mailbox you want to check the OOF of (this is just an array or Strings)  
 
$cred = New-Object System.Net.NetworkCredential("user1@domain.com","password@#")

Credentials to use

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


  1. $MailboxName = "sender@domain.com"  
  2.   
  3. $Mailboxes = @("user1@domain.com","user2@domain.com")   
  4.   
  5. $cred = New-Object System.Net.NetworkCredential("user1@domain.com","password@#")   
  6.   
  7. $dllpath = "C:\Program Files\Microsoft\Exchange\Web Services\1.1\Microsoft.Exchange.WebServices.dll"  
  8. [void][Reflection.Assembly]::LoadFile($dllpath)   
  9. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP1)   
  10. $service.TraceEnabled = $false  
  11.   
  12. $service.Credentials = $cred  
  13. $service.autodiscoverurl($MailboxName,{$true})   
  14.   
  15.   
  16. $expRequest = @"  
  17. <?xml version="1.0" encoding="utf-8"?>  
  18. <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">  
  19. <soap:Header><RequestServerVersion Version="Exchange2010_SP1" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" />  
  20. </soap:Header>  
  21. <soap:Body>  
  22. <GetMailTips xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">  
  23. <SendingAs>  
  24. <EmailAddress xmlns="http://schemas.microsoft.com/exchange/services/2006/types">$MailboxName</EmailAddress>  
  25. </SendingAs>  
  26. <Recipients>  
  27. "@   
  28.   
  29. foreach($mbMailbox in $Mailboxes){   
  30.     $expRequest = $expRequest + "<Mailbox xmlns=`"http://schemas.microsoft.com/exchange/services/2006/types`"><EmailAddress>$mbMailbox</EmailAddress></Mailbox>"    
  31. }   
  32.   
  33. $expRequest = $expRequest + "</Recipients><MailTipsRequested>OutOfOfficeMessage</MailTipsRequested></GetMailTips></soap:Body></soap:Envelope>"  
  34. $mbMailboxFolderURI = New-Object System.Uri($service.url)   
  35. $wrWebRequest = [System.Net.WebRequest]::Create($mbMailboxFolderURI)   
  36. $wrWebRequest.KeepAlive = $false;   
  37. $wrWebRequest.Headers.Set("Pragma""no-cache");   
  38. $wrWebRequest.Headers.Set("Translate""f");   
  39. $wrWebRequest.Headers.Set("Depth""0");   
  40. $wrWebRequest.ContentType = "text/xml";   
  41. $wrWebRequest.ContentLength = $expRequest.Length;   
  42. $wrWebRequest.Timeout = 60000;   
  43. $wrWebRequest.Method = "POST";   
  44. $wrWebRequest.Credentials = $cred  
  45. $bqByteQuery = [System.Text.Encoding]::ASCII.GetBytes($expRequest);   
  46. $wrWebRequest.ContentLength = $bqByteQuery.Length;   
  47. $rsRequestStream = $wrWebRequest.GetRequestStream();   
  48. $rsRequestStream.Write($bqByteQuery, 0, $bqByteQuery.Length);   
  49. $rsRequestStream.Close();   
  50. $wrWebResponse = $wrWebRequest.GetResponse();   
  51. $rsResponseStream = $wrWebResponse.GetResponseStream()   
  52. $sr = new-object System.IO.StreamReader($rsResponseStream);   
  53. $rdResponseDocument = New-Object System.Xml.XmlDocument   
  54. $rdResponseDocument.LoadXml($sr.ReadToEnd());   
  55. $RecipientNodes = @($rdResponseDocument.getElementsByTagName("t:RecipientAddress"))   
  56. $Datanodes = @($rdResponseDocument.getElementsByTagName("t:OutOfOffice"))   
  57. for($ic=0;$ic -lt $RecipientNodes.length;$ic++){   
  58.     if($Datanodes[$ic].ReplyBody.Message -eq ""){   
  59.         $RecipientNodes[$ic].EmailAddress + " : In the Office"  
  60.     }   
  61.     else{   
  62.         $RecipientNodes[$ic].EmailAddress + " : Out of Office"  
  63.     }   
  64. }