Tuesday, March 06, 2012

How To Sample 3 - Scanning all folders in a mailbox for updated Items in EWS

This is the third of my samples based on the EWS Managed API and Powershell how to series I've been writing so if your looking for background on this please refer to these other posts.

EWS has a number of good Synchronization operations which I'll be covering in future posts but i thought I'd go through another method you can use if your looking to find new Items or changed items in a Mailbox.

For example say you have a mailbox with a complicated folder structure with a number of Inbox rules that moves messages to different Folders and you want a script that that will look at all the folders in a Mailbox and only query those folders where the Items in that folder have been updated say since yesterday and return information about those items.

The property you need to use on a folder to know if the underlying Items have change is the PR_LOCAL_COMMIT_TIME_MAX which is one the properties using by ICS see . So we can basically use this property within a Searchfilter in EWS to determine if the underlying items in a folder has been updated after a particular date. To work out which Items are new you then need a conventional AQS item query to look for Items that where received after that said time

There are a few options in this script the first is the time you look at which is controlled by this variable

$queryTime = [system.DateTime]::Now.AddDays(-1)

(this should be self explanatory in terms of date)

The other things I've done is this script is to also query the Dumpster V2 so if Single Item Recovery is enabled in a Mailbox it makes sure it captures everything that has entered. This is done by the following lines

##Option add in the Deletions Folder
$delfolderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::RecoverableItemsDeletions,$MailboxName)
$DelFolder = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$delfolderid)

and

$findFolderResults.Folders.Add($DelFolder)

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

  1. ## Load Managed API dll  
  2. Add-Type -Path "C:\Program Files\Microsoft\Exchange\Web Services\1.1\Microsoft.Exchange.WebServices.dll"  
  3.   
  4. ## Set Exchange Version  
  5. $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP1  
  6.   
  7. ## Create Exchange Service Object  
  8. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService($ExchangeVersion)  
  9.   
  10. ## Set Credentials to use two options are availible Option1 to use explict credentials or Option 2 use the Default (logged On) credentials  
  11.   
  12. #Credentials Option 1 using UPN for the windows Account  
  13. $creds = New-Object System.Net.NetworkCredential("user@domain.com","password")   
  14. $service.Credentials = $creds      
  15.   
  16. #Credentials Option 2  
  17. #service.UseDefaultCredentials = $true  
  18.   
  19. ## Choose to ignore any SSL Warning issues caused by Self Signed Certificates  
  20.   
  21. [System.Net.ServicePointManager]::ServerCertificateValidationCallback = {$true}  
  22.   
  23. ## 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  
  24.   
  25. $MailboxName = "user@domain.com"  
  26. #CAS URL Option 1 Autodiscover  
  27. $service.AutodiscoverUrl($MailboxName,{$true})  
  28. "Using CAS Server : " + $Service.url   
  29.   
  30. #Define Query Time  
  31.   
  32. $queryTime = [system.DateTime]::Now.AddDays(-1)  
  33.   
  34. $PR_LOCAL_COMMIT_TIME_MAX = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x670A, [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::SystemTime);  
  35.   
  36. $fvFolderView = new-object Microsoft.Exchange.WebServices.Data.FolderView(1000)  
  37. $fvFolderView.Traversal = [Microsoft.Exchange.WebServices.Data.FolderTraversal]::Deep  
  38. $folderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::MsgFolderRoot,$MailboxName)   
  39. $SfSearchFilter = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsGreaterThan($PR_LOCAL_COMMIT_TIME_MAX,$queryTime)  
  40.   
  41. ##Option add in the Deletions Folder  
  42. $delfolderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::RecoverableItemsDeletions,$MailboxName)   
  43. $DelFolder = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$delfolderid)  
  44.   
  45. $tfTargetFolder = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  46.   
  47. $findFolderResults = $tfTargetFolder.FindFolders($SfSearchFilter,$fvFolderView)  
  48. $findFolderResults.Folders.Add($DelFolder)  
  49.   
  50. $AQSString =  "System.Message.DateReceived:>" + $queryTime.ToString("MM/dd/yyyy")  
  51. $AQSString  
  52. foreach($folder in $findFolderResults.Folders){  
  53.     if($folder.TotalCount -gt 0){  
  54.         "Processing Folder " + $folder.DisplayName  
  55.         $ivItemView = New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)  
  56.         $findItemsResults = $null  
  57.         do{  
  58.             $findItemsResults = $folder.FindItems($AQSString,$ivItemView)  
  59.             foreach($itItem in $findItemsResults.Items){  
  60.                 $itItem.Subject  
  61.             }  
  62.             $ivItemView.offset += $findItemsResults.Items.Count  
  63.         }while($findItemsResults.MoreAvailable -eq $true)  
  64.     }  
  65. }  

No comments: