Monday, September 10, 2012

Reporting on the Outlook Client Junk Email filter with EWS and Powershell

Within most Exchange Orgs there are multiple levels of SPAM and junk email filtering that may include Cloud based first level filtering like Postini and Forefront and then other server based filters like those standard AS features that come with the Transport Server role with Exchange 2010. At the client level if you have the Outlook 200x junk email filter enabled it will also be providing another level of Junk Email filtering.  The one difference being that while the cloud and server based solutions filter email while it is in the Transport Pipeline the client based filter will only filter it once it has arrived in a Mailbox folder and it can also filter content such as RSS feeds that don't come via the transport mechanism.

Although inevitably the Junk Email ends up in the Junk Email folder when the client  side filter takes action on an Item it adds some extra Extended properties that can be used from a reporting perspective. The most interesting is

PidLidSpamOriginalFolder http://msdn.microsoft.com/en-us/library/office/cc765862.aspx

This reflects the original Mailbox Folder where the Email was filtered from. When using this property in a EWS script you will get the HexEntryID of the original folder which you then need to convert to an EWSID using the convert-ID operation to make use of in EWS.

So I've put together the followng script that will report on a Mailbox's JunkEmail folder and tell if any of the Items have been filtered by the Server or Client and if they where filtered by the Client what the original folder was that the email came from . To Run the script you need to supply it with the PrimarySMTPAddress of the account you want to run it against (eg ./jmreport.ps1 mailbox@domain.com)  and it will then output the result to c:\temp.

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

  1. ## Get the Mailbox to Access from the 1st commandline argument  
  2. $rptCollection = @()  
  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]::JunkEmail,$MailboxName)     
  75. $JunkEmail = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  76.   
  77. $PidLidSpamOriginalFolder = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition([Microsoft.Exchange.WebServices.Data.DefaultExtendedPropertySet]::Common,0x859C, [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::Binary)  
  78. $psPropset= new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)    
  79. $psPropset.Add($PidLidSpamOriginalFolder)  
  80.   
  81. #Define ItemView to retrive just 1000 Items  
  82. $fldIdHash = @{}  
  83. $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)  
  84. $ivItemView.PropertySet = $psPropset   
  85. $fiItems = $null      
  86. do{      
  87.     $fiItems = $service.FindItems($JunkEmail.Id,$ivItemView)      
  88.     #[Void]$service.LoadPropertiesForItems($fiItems,$psPropset)    
  89.     foreach($Item in $fiItems.Items){   
  90.         $rptobj = "" | Select DateTimeReceived,Subject,FilteredBy,OriginalFolder  
  91.         $propval = $null  
  92.         $rptobj.Subject = $Item.Subject  
  93.         $rptobj.DateTimeReceived = $Item.DateTimeReceived  
  94.         if($Item.TryGetProperty($PidLidSpamOriginalFolder,[ref]$propval)){  
  95.   
  96.             $fldName = ""  
  97.             $FolderEntryId = $null  
  98.             $FolderEntryId = [System.BitConverter]::ToString($propval).Replace("-","")  
  99.             if($fldIdHash.ContainsKey($FolderEntryId) -eq $false){  
  100.                     $aiItem = New-Object Microsoft.Exchange.WebServices.Data.AlternateId        
  101.                     $aiItem.Mailbox = $MailboxName        
  102.                     $aiItem.UniqueId = $FolderEntryId     
  103.                     $aiItem.Format = [Microsoft.Exchange.WebServices.Data.IdFormat]::HexEntryId;    
  104.                     $fldId = $null  
  105.                     $fldId = $service.ConvertId($aiItem, [Microsoft.Exchange.WebServices.Data.IdFormat]::EwsId)    
  106.                     $fld = $null  
  107.                     if($fldId -ne $null){  
  108.                         $orgID = new-object Microsoft.Exchange.WebServices.Data.FolderId($fldId.UniqueId)     
  109.                         $fld = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$orgID)  
  110.                         $fldIdHash.Add($FolderEntryId,$fld.DisplayName)  
  111.                         $fldName = $fld.DisplayName  
  112.                     }  
  113.                               
  114.             }  
  115.             else{  
  116.                 $fldName = $fldIdHash[$FolderEntryId]  
  117.             }  
  118.             $rptobj.FilteredBy = "Client"  
  119.             $rptobj.OriginalFolder = $fldName     
  120.         }  
  121.         else{  
  122.             $rptobj.FilteredBy = "Server"             
  123.         }     
  124.         $rptCollection += $rptobj  
  125.     }      
  126.     $ivItemView.Offset += $fiItems.Items.Count      
  127. }while($fiItems.MoreAvailable -eq $true)   
  128. $rptCollection | Export-Csv c:\temp\junkemailClientreport.csv -NoTypeInformation  

4 comments:

Anonymous said...

Attempted Download of code: 404 - File or directory not found. Please fix. Thanks.

Glen Scales said...

The download link should be okay now

Cheers
Glen

Joachim said...

Tried with Exchange Admin

Exception calling "Bind" with "2" argument(s): "The request failed. The remote server returned an error: (401) Unauthor
ized."
At C:\it\scripts\jmreport.ps1:75 char:64
+ $JunkEmail = [Microsoft.Exchange.WebServices.Data.Folder]::Bind <<<< ($service,$folderid)
+ CategoryInfo : NotSpecified: (:) [], MethodInvocationException
+ FullyQualifiedErrorId : DotNetMethodException

AutoDiscovewr Option works not too.
We have no problems with AutoDiscover in our domain...?

Glen Scales said...

Admin rights don't mean anything this script using EWS to access the Mailbox so requires that you have Access the Mailbox in question eg add-mailboxpermission FullAccess