Wednesday, April 16, 2014

Using EWS and AQS to check number of Unread in X days with Graph

It seems that you can never have too many ways of reading the number of Unread messages in a Inbox so here is another method. The following script uses two AQS queries to work out first the number of messages in the Inbox from a prescribed period eg the last 30 days and then the number of these that are then unread. It then works out the percentage of unread using of the two values and then creates a graph to display in the Console using Alt-ASCII characters which produces a pretty nifty output eg


It also produces a CSV output eg


AQS queries will work in Exchange 2010 and 2013 so this script should work okay in those environments as well as ExchangeOnline.

I've created two versions of this script, the first version just reports on one user so you run it with the email of the users you want to report on and the number of days to query back. eg

.\AQSUsr.ps1 gscales1@msgdevelop.onmicrosoft.com 30

the second version reports on all of the users in a CSV file and uses EWS Impersonation to access the Mailboxes. To use the script you need to have configured EWS Impersonation and feed the script a CSV file of the users you want to report on eg the CSV file should look like

smtpaddress
user1@domain.com
user2@domain.com

and you run it like

.\AQSAllUsr.ps1 ./users.csv 30

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


  1. ## Get the Mailbox to Access from the 1st commandline argument  
  2.   
  3. $csvFileName = $args[0]  
  4. $DaysBack = $args[1]  
  5.   
  6. ## Load Managed API dll    
  7. Add-Type -Path "C:\Program Files\Microsoft\Exchange\Web Services\2.0\Microsoft.Exchange.WebServices.dll"    
  8.     
  9. ## Set Exchange Version    
  10. $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP2    
  11.     
  12. ## Create Exchange Service Object    
  13. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService($ExchangeVersion)    
  14.     
  15. ## Set Credentials to use two options are availible Option1 to use explict credentials or Option 2 use the Default (logged On) credentials    
  16.     
  17. #Credentials Option 1 using UPN for the windows Account    
  18. $psCred = Get-Credential    
  19. $creds = New-Object System.Net.NetworkCredential($psCred.UserName.ToString(),$psCred.GetNetworkCredential().password.ToString())    
  20. $service.Credentials = $creds        
  21.     
  22. #Credentials Option 2    
  23. #service.UseDefaultCredentials = $true    
  24.     
  25. ## Choose to ignore any SSL Warning issues caused by Self Signed Certificates    
  26.     
  27. ## Code From http://poshcode.org/624  
  28. ## Create a compilation environment  
  29. $Provider=New-Object Microsoft.CSharp.CSharpCodeProvider  
  30. $Compiler=$Provider.CreateCompiler()  
  31. $Params=New-Object System.CodeDom.Compiler.CompilerParameters  
  32. $Params.GenerateExecutable=$False  
  33. $Params.GenerateInMemory=$True  
  34. $Params.IncludeDebugInformation=$False  
  35. $Params.ReferencedAssemblies.Add("System.DLL") | Out-Null  
  36.   
  37. $TASource=@' 
  38.   namespace Local.ToolkitExtensions.Net.CertificatePolicy{ 
  39.     public class TrustAll : System.Net.ICertificatePolicy { 
  40.       public TrustAll() {  
  41.       } 
  42.       public bool CheckValidationResult(System.Net.ServicePoint sp, 
  43.         System.Security.Cryptography.X509Certificates.X509Certificate cert,  
  44.         System.Net.WebRequest req, int problem) { 
  45.         return true; 
  46.       } 
  47.     } 
  48.   } 
  49. '@   
  50. $TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)  
  51. $TAAssembly=$TAResults.CompiledAssembly  
  52.   
  53. ## We now create an instance of the TrustAll and attach it to the ServicePointManager  
  54. $TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")  
  55. [System.Net.ServicePointManager]::CertificatePolicy=$TrustAll  
  56.   
  57. ## end code from http://poshcode.org/624  
  58.     
  59. ## 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    
  60.     
  61. #CAS URL Option 1 Autodiscover    
  62. #$service.AutodiscoverUrl($MailboxName,{$true})    
  63. #"Using CAS Server : " + $Service.url     
  64.      
  65. #CAS URL Option 2 Hardcoded    
  66.     
  67. #$uri=[system.URI] "https://casservername/ews/exchange.asmx"    
  68. #$service.Url = $uri      
  69.     
  70. ## Optional section for Exchange Impersonation    
  71.     
  72.   
  73. $Script:rptCollection = @()  
  74. function Process-Mailbox{    
  75.     param (    
  76.             $SmtpAddress = "$( throw 'SMTPAddress is a mandatory Parameter' )"    
  77.           )    
  78.     process{    
  79.         Write-Host ("Processing Mailbox : " + $SmtpAddress)    
  80.   
  81. # Bind to the Inbox Folder  
  82. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$SmtpAddress)     
  83. $Inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  84. $Range = [system.DateTime]::Now.AddDays(-$DaysBack).ToString("MM/dd/yyyy") + ".." + [system.DateTime]::Now.AddDays(1).ToString("MM/dd/yyyy")     
  85. $AQSString1 = "System.Message.DateReceived:" + $Range     
  86. $AQSString2 = "(" + $AQSString1 + ") AND (isread:false)"   
  87. $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)    
  88. $allMail = $Inbox.FindItems($AQSString1,$ivItemView)  
  89. $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)   
  90. $unread = $Inbox.FindItems($AQSString2,$ivItemView)  
  91. $rptObj = "" | Select MailboxName,TotalCount,Unread,PercentUnread,PercentGraph  
  92.   
  93. #Write-Host ("All Mail " + $allMail.TotalCount)   
  94. #Write-Host ("Unread " + $unread.TotalCount)   
  95. $rptObj.MailboxName = $SmtpAddress  
  96. $rptObj.TotalCount = $allMail.TotalCount  
  97. $rptObj.Unread = $unread.TotalCount   
  98. $PercentUnread = 0  
  99. if($unread.TotalCount -gt 0){  
  100.     $PercentUnread = [Math]::round((($unread.TotalCount/$allMail.TotalCount) * 100))  
  101. }  
  102. $rptObj.PercentUnread = $PercentUnread   
  103. #Write-Host ("Percent Unread " + $PercentUnread)  
  104. $ureadGraph = ""  
  105. for($intval=0;$intval -lt 100;$intval+=4){  
  106.     if($PercentUnread -gt $intval){  
  107.         $ureadGraph += "▓"  
  108.     }  
  109.     else{         
  110.         $ureadGraph += "░"  
  111.     }  
  112. }  
  113. #Write-Host $ureadGraph  
  114. $rptObj.PercentGraph = $ureadGraph  
  115. $rptObj | fl  
  116. $Script:rptCollection +=$rptObj  
  117.   
  118. }  
  119. }  
  120. Import-Csv -Path $csvFileName | ForEach-Object{    
  121.     if($service.url -eq $null){    
  122.         $service.AutodiscoverUrl($_.SmtpAddress,{$true})     
  123.         "Using CAS Server : " + $Service.url     
  124.     }    
  125.     Try{    
  126.         $service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $_.SmtpAddress)   
  127.   
  128.         Process-Mailbox -SmtpAddress $_.SmtpAddress    
  129.     }    
  130.     catch{    
  131.         Write-host ("Error processing Mailbox : " + $_.SmtpAddress + $_.Exception.Message.ToString())    
  132.         $Error.Clear()  
  133.     }    
  134. }    
  135. $Script:rptCollection | ft  
  136. $Script:rptCollection | Export-Csv -NoTypeInformation -Path c:\temp\InboxUnreadReport.csv -Encoding UTF8   

6 comments:

exxoid said...

Hey Glen,

Does this script work with EWS 2.1 and Exchange2013_SP1? I tried it with those settings and it returned TotalCount as 3, but that is not correct.

Using EWS 2.0 and Exchange2012_SP2 it returns the correct value.

I am running this against Exchange 2013, anyway to make it happy with the updated EWS Managed API?

Glen Scales said...

I would say it's probably the DateFormat that is the issue try using the following line instead

$Range = [system.DateTime]::Now.AddDays(-$DaysBack).ToString("yyyy-MM-dd") + ".." + [system.DateTime]::Now.ToString("yyyy-MM-dd")

Cheers
Glen

exxoid said...

I tried updating the script with that and no go..

I have set..

## Load Managed API dll
Add-Type -Path "C:\Program Files (x86)\Microsoft\Exchange\Web Services\2.1\Microsoft.Exchange.WebServices.dll"

## Set Exchange Version
$ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2013_SP1

Then replaced $Range with what you have and what I get is..

PS C:\Users\test\Documents\MEGA\test\Exchange 2013> .\AQSUsr.ps1 test@test.com

cmdlet Get-Credential at command pipeline position 1
Supply values for the following parameters:
Credential


MailboxName : test@test.com
TotalCount : 1
Unread : 0
PercentUnread : 0
PercentGraph : ▓░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░

The particular mailbox has 48 items, 0 unread. I tried with another mailbox and I got Total Count/Unread 250/250, but this particular mailbox Inbox had 1300 emails and 900 unread.

Both mailboxes are on Exchange 2013 SP1 CU5 (Windows 2012 R2).

Glen Scales said...

I've tried it against Office365 which is 2013 and it works okay, you can test the AQS query using the EWSeditor and right click the folder and try out the query. These queries rely on healthy indexes

One thing I noticed is that you haven't entered a parameter for the number of days you want to report on so the result you got was expected you need to use

\AQSUsr.ps1 test@test.com 30

where 30 is the number of days you reporting against, not the Total count is the number of message in the last 30 days in this instance not the total for the folder. If you want to capture all the messages in a folder just use a large value eg

\AQSUsr.ps1 test@test.com (20*365)

would capture the last 20 years

Cheers
Glen

Glen Scales said...

The 250 Item issue looks like a bug in CU5 when using AQS hopeful they will fix this in the next CU

Anonymous said...

We are calling ESW methods to get exchange data and for some reason this following call doesn’t work at certain clients.

Method is:
LoadPropertiesForItems

Here is the error we get back:
[2008] Unable to load items jhalper@orrick.com (Inbox)

But if I use EWSEditor connecting with the same userid/pwd as the code uses, it is able to open this users inbox.

Can you suggest the best tool to debug??