Thursday, October 04, 2012

Reporting on the Item Age (Count and Size) in a Mailbox using EWS and Powershell (MEC Sample)

This is sample 2 from the Item Age section of my MEC talk in this sample we'll look at reporting on the Folder ItemCounts and Size of Item's in a Mailbox based on the age of those items.

To work out the Size and Item Count of all the Items in a Mailbox and be able to report on the age of those Items requires that you enumerate through every item in every folder in a Mailbox. Doing this on a mailbox with a large number of folder Items will take some time (it's pretty elementary Watson). So to reduce the amount of work that the server has to do to return information about all the Items in the Mailbox it's important to use the IdOnly BasePropertySet and then add the properties that are required. For this report the following properties are used.

Size, DateTimeReceived, DateTimeCreated

This script first uses a FindFolder operation to enumerate all folders in a Mailbox and then on each folder a findItems is used to enumerate ever item.

Using just these three properties and a Hashtable we can create an aggregation of Year part of the  DateTimeReceived (or DateTimeCreated) and the it produces a report like the following for all items in a Mailbox



I've also created a script that breaks out the age of items based on every folder and then create a report of every folder . This tends to be quite noisy but maybe useful if your looking for a more detailed breakdown.

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

  1. ## Get the Mailbox to Access from the 1st commandline argument  
  2.   
  3. $MailboxName = $args[0]  
  4.   
  5. ## Load Managed API dll    
  6. Add-Type -Path "C:\Program Files\Microsoft\Exchange\Web Services\1.2\Microsoft.Exchange.WebServices.dll"    
  7.     
  8. ## Set Exchange Version    
  9. $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP2    
  10.     
  11. ## Create Exchange Service Object    
  12. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService($ExchangeVersion)    
  13.     
  14. ## Set Credentials to use two options are availible Option1 to use explict credentials or Option 2 use the Default (logged On) credentials    
  15.     
  16. #Credentials Option 1 using UPN for the windows Account    
  17. $psCred = Get-Credential    
  18. $creds = New-Object System.Net.NetworkCredential($psCred.UserName.ToString(),$psCred.GetNetworkCredential().password.ToString())    
  19. $service.Credentials = $creds        
  20.     
  21. #Credentials Option 2    
  22. #service.UseDefaultCredentials = $true    
  23.     
  24. ## Choose to ignore any SSL Warning issues caused by Self Signed Certificates    
  25.     
  26. ## Code From http://poshcode.org/624  
  27. ## Create a compilation environment  
  28. $Provider=New-Object Microsoft.CSharp.CSharpCodeProvider  
  29. $Compiler=$Provider.CreateCompiler()  
  30. $Params=New-Object System.CodeDom.Compiler.CompilerParameters  
  31. $Params.GenerateExecutable=$False  
  32. $Params.GenerateInMemory=$True  
  33. $Params.IncludeDebugInformation=$False  
  34. $Params.ReferencedAssemblies.Add("System.DLL") | Out-Null  
  35.   
  36. $TASource=@' 
  37.   namespace Local.ToolkitExtensions.Net.CertificatePolicy{ 
  38.     public class TrustAll : System.Net.ICertificatePolicy { 
  39.       public TrustAll() {  
  40.       } 
  41.       public bool CheckValidationResult(System.Net.ServicePoint sp, 
  42.         System.Security.Cryptography.X509Certificates.X509Certificate cert,  
  43.         System.Net.WebRequest req, int problem) { 
  44.         return true; 
  45.       } 
  46.     } 
  47.   } 
  48. '@   
  49. $TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)  
  50. $TAAssembly=$TAResults.CompiledAssembly  
  51.   
  52. ## We now create an instance of the TrustAll and attach it to the ServicePointManager  
  53. $TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")  
  54. [System.Net.ServicePointManager]::CertificatePolicy=$TrustAll  
  55.   
  56. ## end code from http://poshcode.org/624  
  57.     
  58. ## 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    
  59.     
  60. #CAS URL Option 1 Autodiscover    
  61. $service.AutodiscoverUrl($MailboxName,{$true})    
  62. "Using CAS Server : " + $Service.url     
  63.      
  64. #CAS URL Option 2 Hardcoded    
  65.     
  66. #$uri=[system.URI] "https://casservername/ews/exchange.asmx"    
  67. #$service.Url = $uri      
  68.     
  69. ## Optional section for Exchange Impersonation    
  70.     
  71. #$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName)   
  72.   
  73. # Bind to the Inbox Folder  
  74. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)     
  75. $Inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  76.   
  77. #Define ItemView to retrive just 1000 Items      
  78. $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)    
  79. $psPropset= new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::IdOnly)    
  80. $psPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::Size)  
  81. $psPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::DateTimeReceived)  
  82. $psPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::DateTimeCreated)  
  83. $ivItemView.PropertySet = $psPropset  
  84. $TotalSize = 0  
  85. $TotalItemCount = 0  
  86.   
  87.   
  88. #Define Function to convert String to FolderPath    
  89. function ConvertToString($ipInputString){    
  90.     $Val1Text = ""    
  91.     for ($clInt=0;$clInt -lt $ipInputString.length;$clInt++){    
  92.             $Val1Text = $Val1Text + [Convert]::ToString([Convert]::ToChar([Convert]::ToInt32($ipInputString.Substring($clInt,2),16)))    
  93.             $clInt++    
  94.     }    
  95.     return $Val1Text    
  96. }   
  97.   
  98. #Define Extended properties    
  99. $PR_FOLDER_TYPE = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(13825,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::Integer);    
  100. $folderidcnt = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::MsgFolderRoot,$MailboxName)    
  101. #Define the FolderView used for Export should not be any larger then 1000 folders due to throttling    
  102. $fvFolderView =  New-Object Microsoft.Exchange.WebServices.Data.FolderView(1000)    
  103. #Deep Transval will ensure all folders in the search path are returned    
  104. $fvFolderView.Traversal = [Microsoft.Exchange.WebServices.Data.FolderTraversal]::Deep;    
  105. $psPropertySet = new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)    
  106. $PR_Folder_Path = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(26293, [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);    
  107. #Add Properties to the  Property Set    
  108. $psPropertySet.Add($PR_Folder_Path);    
  109. $fvFolderView.PropertySet = $psPropertySet;    
  110. #The Search filter will exclude any Search Folders    
  111. $sfSearchFilter = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo($PR_FOLDER_TYPE,"1")    
  112. $fiResult = $null    
  113. $rptHash = @{}        
  114. $minYear = (Get-Date).Year  
  115. $maxYear = (Get-Date).Year  
  116. #The Do loop will handle any paging that is required if there are more the 1000 folders in a mailbox    
  117. do {    
  118.     $fiResult = $Service.FindFolders($folderidcnt,$sfSearchFilter,$fvFolderView)    
  119.     foreach($ffFolder in $fiResult.Folders){    
  120.         $foldpathval = $null    
  121.         #Try to get the FolderPath Value and then covert it to a usable String     
  122.         if ($ffFolder.TryGetProperty($PR_Folder_Path,[ref] $foldpathval))    
  123.         {    
  124.             $binarry = [Text.Encoding]::UTF8.GetBytes($foldpathval)    
  125.             $hexArr = $binarry | ForEach-Object { $_.ToString("X2") }    
  126.             $hexString = $hexArr -join ''    
  127.             $hexString = $hexString.Replace("FEFF""5C00")    
  128.             $fpath = ConvertToString($hexString)    
  129.         }    
  130.         "FolderPath : " + $fpath    
  131.           
  132.         #Define ItemView to retrive just 1000 Items      
  133.         $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)    
  134.         $psPropset= new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::IdOnly)    
  135.         $psPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::Size)  
  136.         $psPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::DateTimeReceived)  
  137.         $psPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::DateTimeCreated)  
  138.         $ivItemView.PropertySet = $psPropset  
  139.           
  140.           
  141.         $fiItems = $null      
  142.         do{      
  143.             $fiItems = $service.FindItems($ffFolder.Id,$ivItemView)      
  144.             #[Void]$service.LoadPropertiesForItems($fiItems,$psPropset)    
  145.             foreach($Item in $fiItems.Items){  
  146.                 $dateVal = $null  
  147.                 if($Item.TryGetProperty([Microsoft.Exchange.WebServices.Data.ItemSchema]::DateTimeReceived,[ref]$dateVal )-eq $false){  
  148.                     $dateVal = $Item.DateTimeCreated  
  149.                 }  
  150.                 if($rptHash.ContainsKey($dateVal.Year)){  
  151.                     $rptHash[$dateVal.Year].TotalNumber += 1  
  152.                     $rptHash[$dateVal.Year].TotalSize += [Int64]$Item.Size  
  153.                 }  
  154.                 else{  
  155.                     $rptObj = "" | Select TotalNumber,TotalSize  
  156.                     $rptObj.TotalNumber = 1  
  157.                     $rptObj.TotalSize = [Int64]$Item.Size  
  158.                     $rptHash.add($dateVal.Year,$rptObj)  
  159.                     if($dateVal.Year -lt $minYear){$minYear = $dateVal.Year}  
  160.                 }  
  161.             }      
  162.             $ivItemView.Offset += $fiItems.Items.Count      
  163.         }while($fiItems.MoreAvailable -eq $true)          
  164.     }   
  165.     $fvFolderView.Offset += $fiResult.Folders.Count  
  166. }while($fiResult.MoreAvailable -eq $true)  
  167. $rptCollection = @()  
  168. $fnFinalreporttlt = "" | Select Name,TotalNumber,TotalSize  
  169. $fnFinalreporttlt.Name = $MailboxName  
  170. $rptCollection += $fnFinalreporttlt  
  171. $fnFinalreport = "" | Select Name,TotalNumber,TotalSize  
  172. $rptCollection += $fnFinalreport  
  173. $rptHash.GetEnumerator() | Sort-Object Name | ForEach-Object {  
  174.     $fnFinalreport = "" | Select Name,TotalNumber,TotalSize  
  175.     $fnFinalreport.Name = $_.key  
  176.     $fnFinalreport.TotalNumber = $rptHash[$_.key].TotalNumber  
  177.     $fnFinalreport.TotalSize = [Math]::Round($rptHash[$_.key].TotalSize/1MB,2)  
  178.     $fnFinalreporttlt.TotalNumber += $rptHash[$_.key].TotalNumber  
  179.     $fnFinalreporttlt.TotalSize += [Math]::Round($rptHash[$_.key].TotalSize/1MB,2)  
  180.     $rptCollection += $fnFinalreport  
  181. }  
  182.   
  183. $tableStyle = @" 
  184. <style> 
  185. BODY{background-color:white;} 
  186. TABLE{border-width: 1px; 
  187.   border-style: solid; 
  188.   border-color: black; 
  189.   border-collapse: collapse; 
  190. } 
  191. TH{border-width: 1px; 
  192.   padding: 10px; 
  193.   border-style: solid; 
  194.   border-color: black; 
  195.   background-color:#66CCCC 
  196. } 
  197. TD{border-width: 1px; 
  198.   padding: 2px; 
  199.   border-style: solid; 
  200.   border-color: black; 
  201.   background-color:white 
  202. } 
  203. </style> 
  204. "@  
  205.     
  206. $body = @" 
  207. <p style="font-size:25px;family:calibri;color:#ff9100">  
  208. $TableHeader  
  209. </p>  
  210. "@  
  211.   
  212. $rptCollection | ConvertTo-HTML -head $tableStyle –body $body | Out-File c:\temp\MailboxAgeReportSummary.htm