Monday, February 27, 2012

HowTo Series Sample 1 - Unused Mailbox report for Exchange 2010

The is the first of my samples based on the EWS Managed API and Powershell how to series I've been writing. This one is actually an update to a script i wrote a few years ago to find unused mailboxes on Exchange 2007. This script is designed to be run from within a Remote Powershell session that is already connected to your Exchange 2010 org (or from a Exchange Online/Office365 remote powershell session).

 It uses Get-Mailbox to get all the mailboxes in your org and then it uses the EWS Managed API to connect to each mailbox and makes a query of the Inbox (using a AQS query String) to get all the Email in the mailbox for the last 6 months,  then it queries for all email in the last 6 months that is still marked unread. Then it queries the Sent Email folder for how many email where sent for the last 6 months. (this would only be accurate based on the user behavior of moving messages). Its combines this with the statistics from Get-MailboxStatistics to produce a csv file that would give you a report that looks like


If you want to understand how it works have a read of the How To Series posts and hopefully you should be able to work out how to customize it if you need to for your own environment. The Script as posted uses EWS Impersonation

If you want to customize which mailboxes it reports on then just change the Get-Mailbox line

Get-Mailbox -ResultSize Unlimited | ForEach-Object{  

eg if you want to limit to only checking one server you could use

Get-Mailbox -ResultSize Unlimited -Server servernameblah | ForEach-Object{

You could do similar with other filter properties such as Database or OU

I've posted a downloadable version here

The script itself looks like

  1. ## EWS Managed API Connect Module Script written by Glen Scales  
  2. ## Requires the EWS Managed API and Powershell V2.0 or greator  
  3. $RptCollection = @()  
  4. ## Load Managed API dll  
  5. Add-Type -Path "C:\Program Files\Microsoft\Exchange\Web Services\1.2\Microsoft.Exchange.WebServices.dll"  
  6.   
  7. ## Set Exchange Version  
  8. $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP1  
  9.   
  10. ## Create Exchange Service Object  
  11. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService($ExchangeVersion)  
  12.   
  13. ## Set Credentials to use two options are availible Option1 to use explict credentials or Option 2 use the Default (logged On) credentials  
  14.   
  15. #Credentials Option 1 using UPN for the windows Account  
  16. $psCred = Get-Credential  
  17. $creds = New-Object System.Net.NetworkCredential($psCred.UserName.ToString(),$psCred.GetNetworkCredential().password.ToString())  
  18. $service.Credentials = $creds      
  19.   
  20. #Credentials Option 2  
  21. #service.UseDefaultCredentials = $true  
  22.   
  23. ## Choose to ignore any SSL Warning issues caused by Self Signed Certificates  
  24.   
  25. ## Code From http://poshcode.org/624  
  26. ## Create a compilation environment  
  27. $Provider=New-Object Microsoft.CSharp.CSharpCodeProvider  
  28. $Compiler=$Provider.CreateCompiler()  
  29. $Params=New-Object System.CodeDom.Compiler.CompilerParameters  
  30. $Params.GenerateExecutable=$False  
  31. $Params.GenerateInMemory=$True  
  32. $Params.IncludeDebugInformation=$False  
  33. $Params.ReferencedAssemblies.Add("System.DLL") | Out-Null  
  34.   
  35. $TASource=@' 
  36. namespace Local.ToolkitExtensions.Net.CertificatePolicy{ 
  37. public class TrustAll : System.Net.ICertificatePolicy { 
  38. public TrustAll() { 
  39. } 
  40. public bool CheckValidationResult(System.Net.ServicePoint sp, 
  41. System.Security.Cryptography.X509Certificates.X509Certificate cert, 
  42. System.Net.WebRequest req, int problem) { 
  43. return true; 
  44. } 
  45. } 
  46. } 
  47. '@  
  48. $TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)  
  49. $TAAssembly=$TAResults.CompiledAssembly  
  50.   
  51. ## We now create an instance of the TrustAll and attach it to the ServicePointManager  
  52. $TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")  
  53. [System.Net.ServicePointManager]::CertificatePolicy=$TrustAll  
  54.   
  55. ## end code from http://poshcode.org/624  
  56.   
  57.   
  58. function CovertBitValue($String){  
  59.     $numItempattern = '(?=\().*(?=bytes)'  
  60.     $matchedItemsNumber = [regex]::matches($String$numItempattern)   
  61.     $Mb = [INT64]$matchedItemsNumber[0].Value.Replace("(","").Replace(",","")  
  62.     return [math]::round($Mb/1048576,0)  
  63. }  
  64.   
  65. Get-Mailbox -ResultSize Unlimited | ForEach-Object{   
  66. $MailboxName = $_.PrimarySMTPAddress.ToString()  
  67. "Processing Mailbox : " + $MailboxName  
  68. if($service.url -eq $null){  
  69.     ## Set the URL of the CAS (Client Access Server) to use two options are availbe to use Autodiscover to find the CAS URL or Hardcode the CAS to use  
  70.   
  71.     #CAS URL Option 1 Autodiscover  
  72.     $service.AutodiscoverUrl($MailboxName,{$true})  
  73.     "Using CAS Server : " + $Service.url   
  74.       
  75.     #CAS URL Option 2 Hardcoded  
  76.     #$uri=[system.URI] "https://casservername/ews/exchange.asmx"  
  77.     #$service.Url = $uri    
  78. }  
  79.   
  80.   
  81. $rptObj = "" | select  MailboxName,Mailboxsize,LastLogon,LastLogonAccount,Last6MonthsTotal,Last6MonthsUnread,LastMailRecieved,Last6MonthsSent,LastMailSent  
  82. $rptObj.MailboxName = $MailboxName  
  83.   
  84. $service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName)  
  85.   
  86.   
  87. $Range = [system.DateTime]::Now.AddMonths(-6).ToString("MM/dd/yyyy") + ".." + [system.DateTime]::Now.ToString("MM/dd/yyyy")   
  88. $AQSString1 = "System.Message.DateReceived:" + $Range   
  89. $AQSString2 = $AQSString1 + " and isread:false"  
  90. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)     
  91. $Inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  92.   
  93. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::SentItems,$MailboxName)     
  94. $SentItems = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  95.   
  96. $ivItemView = New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)  
  97.   
  98. $MailboxStats = Get-MailboxStatistics $MailboxName  
  99. $ts = CovertBitValue($MailboxStats.TotalItemSize.ToString())  
  100. "Total Size : " + $MailboxStats.TotalItemSize  
  101. $rptObj.MailboxSize = $ts  
  102. "Last Logon Time : " + $MailboxStats.LastLogonTime  
  103. $rptObj.LastLogon = $MailboxStats.LastLogonTime  
  104. "Last Logon Account : " + $MailboxStats.LastLoggedOnUserAccount  
  105. $rptObj.LastLogonAccount = $MailboxStats.LastLoggedOnUserAccount  
  106. $fiResults = $Inbox.findItems($AQSString1,$ivItemView)  
  107. $rptObj.Last6MonthsTotal = $fiResults.TotalCount  
  108. "Last 6 Months : " + $fiResults.TotalCount  
  109. if($fiResults.TotalCount -gt 0){  
  110.     "Last Mail Recieved : " + $fiResults.Items[0].DateTimeReceived  
  111.     $rptObj.LastMailRecieved = $fiResults.Items[0].DateTimeReceived  
  112. }  
  113. $ivItemView = New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)  
  114. $fiResults = $Inbox.findItems($AQSString2,$ivItemView)  
  115. "Last 6 Months Unread : " + $fiResults.TotalCount  
  116. $rptObj.Last6MonthsUnread = $fiResults.TotalCount  
  117. $ivItemView = New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)  
  118. $fiResults = $SentItems.findItems($AQSString1,$ivItemView)  
  119. "Last 6 Months Sent : " + $fiResults.TotalCount  
  120. $rptObj.Last6MonthsSent = $fiResults.TotalCount  
  121. if($fiResults.TotalCount -gt 0){  
  122.     "Last Mail Sent Date : " + $fiResults.Items[0].DateTimeSent  
  123.     $rptObj.LastMailSent = $fiResults.Items[0].DateTimeSent  
  124. }  
  125. $RptCollection +=$rptObj  
  126. }  
  127. $RptCollection | Export-Csv -NoTypeInformation  c:\temp\unreadReport.csv