Wednesday, November 27, 2013

Mapping what Folders are in use in ActiveSync with EWS and Powershell

[***Ingo Gegenwarth has published an better version of this script that handles the changes made recently to ActiveSync on Exchange Online see https://ingogegenwarth.wordpress.com/2018/01/03/eas-folder-mapping/ ]

I came across an interesting Blog post this week from Jim Martin

http://blogs.technet.com/b/tips_from_the_inside/archive/2013/06/17/activesync-mapping-a-collection-id-to-a-mailbox-folder.aspx

which explains how the ActiveSync Folders located under the device folder in ExchangeSyncData folder tree map back to the real Mailbox folder that is being synchronized or accessed via ActiveSync. This information is pretty useful for a number of things so I thought it would be useful to put a script together to automate and create a report of these folder mapping using EWS and Powershell.

How it works is the ExchangeSyncData is located in the NON_IPM_Subtree of a mailbox so a few FindFolder calls are needed to find this folder and then get all the Folders associated with any ActiveSync devices for the Mailbox. The 0x7C030102 property is set on ActiveSync Collection folder and as in Jim's post if you take the first byte and last byte off the value from this property you have the HexEntryId of the folder. In EWS you can then use convertId to covert it to the ewsID of the Folder and then bind to the FolderId to work out which folder is being synced. Basically what you end up with is a report that looks like this

The LastModified column is the time the ActiveSync folder was last modified which should relate to the last time the folder was accessed over ActiveSync (from my observation anyway). The Device column just comes from the DisplayName of the Root folder from the device

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.   
  3. $MailboxName = $args[0]  
  4. $AsFolderReport = @()  
  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. #$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName)   
  73. # Bind to the MsgFolderRoot folder    
  74. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Root,$MailboxName)     
  75. $MsgRoot = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  76.   
  77. function ConvertId{      
  78.     param (  
  79.             $HexId = "$( throw 'HexId is a mandatory Parameter' )"  
  80.           )  
  81.     process{  
  82.         $aiItem = New-Object Microsoft.Exchange.WebServices.Data.AlternateId        
  83.         $aiItem.Mailbox = $MailboxName        
  84.         $aiItem.UniqueId = $HexId     
  85.         $aiItem.Format = [Microsoft.Exchange.WebServices.Data.IdFormat]::HexEntryId        
  86.         $convertedId = $service.ConvertId($aiItem, [Microsoft.Exchange.WebServices.Data.IdFormat]::EwsId)   
  87.         return $convertedId.UniqueId  
  88.     }  
  89. }  
  90.   
  91. function GetFolderPath{  
  92.     param (  
  93.         $EWSFolder = "$( throw 'Folder is a mandatory Parameter' )"  
  94.     )  
  95.     process{  
  96.         $foldpathval = $null    
  97.         $PR_Folder_Path = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(26293, [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);    
  98.         if ($EWSFolder.TryGetProperty($PR_Folder_Path,[ref] $foldpathval))    
  99.         {    
  100.             $binarry = [Text.Encoding]::UTF8.GetBytes($foldpathval)    
  101.             $hexArr = $binarry | ForEach-Object { $_.ToString("X2") }    
  102.             $hexString = $hexArr -join ''    
  103.         $hexString = $hexString.Replace("EFBFBE""5C")    
  104.             $fpath = ConvertToString($hexString)   
  105.         return $fpath  
  106.         }    
  107.     }  
  108. }  
  109. $fldMappingHash = @{}  
  110. #Define the FolderView used for Export should not be any larger then 1000 folders due to throttling    
  111. $fvFolderView =  New-Object Microsoft.Exchange.WebServices.Data.FolderView(1)    
  112. #Deep Transval will ensure all folders in the search path are returned    
  113. $fvFolderView.Traversal = [Microsoft.Exchange.WebServices.Data.FolderTraversal]::Shallow;    
  114. #The Search filter will exclude any Search Folders    
  115. $sfSearchFilter = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo([Microsoft.Exchange.WebServices.Data.FolderSchema]::DisplayName,"ExchangeSyncData")    
  116. $asFolderRoot = $Service.FindFolders($MsgRoot.Id,$sfSearchFilter,$fvFolderView)    
  117. if($asFolderRoot.Folders.Count -eq 1){  
  118.     #Define Function to convert String to FolderPath    
  119.     function ConvertToString($ipInputString){    
  120.         $Val1Text = ""    
  121.         for ($clInt=0;$clInt -lt $ipInputString.length;$clInt++){    
  122.                 $Val1Text = $Val1Text + [Convert]::ToString([Convert]::ToChar([Convert]::ToInt32($ipInputString.Substring($clInt,2),16)))    
  123.                 $clInt++    
  124.         }    
  125.         return $Val1Text    
  126.     }   
  127.       
  128.     #Define Extended properties    
  129.     $PR_FOLDER_TYPE = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(13825,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::Integer);    
  130.     #Define the FolderView used for Export should not be any larger then 1000 folders due to throttling    
  131.     $fvFolderView =  New-Object Microsoft.Exchange.WebServices.Data.FolderView(1000)    
  132.     #Deep Transval will ensure all folders in the search path are returned    
  133.     $fvFolderView.Traversal = [Microsoft.Exchange.WebServices.Data.FolderTraversal]::Deep;    
  134.     $psPropertySet = new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)    
  135.     $PR_Folder_Path = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(26293, [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);    
  136.     $CollectionIdProp = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x7C03, [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::Binary)  
  137.     $LastModifiedTime = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x3008, [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::SystemTime)  
  138.     #Add Properties to the  Property Set    
  139.     $psPropertySet.Add($PR_Folder_Path);    
  140.     $psPropertySet.Add($CollectionIdProp);  
  141.     $psPropertySet.Add($LastModifiedTime);    
  142.     $fvFolderView.PropertySet = $psPropertySet;    
  143.     #The Search filter will exclude any Search Folders    
  144.     $sfSearchFilter = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo($PR_FOLDER_TYPE,"1")    
  145.     $fiResult = $null    
  146.     #The Do loop will handle any paging that is required if there are more the 1000 folders in a mailbox    
  147.     do {    
  148.         $fiResult = $Service.FindFolders($asFolderRoot.Folders[0].Id,$sfSearchFilter,$fvFolderView)    
  149.         foreach($ffFolder in $fiResult.Folders){   
  150.             if(!$fldMappingHash.ContainsKey($ffFolder.Id.UniqueId)){  
  151.                 $fldMappingHash.Add($ffFolder.Id.UniqueId,$ffFolder)  
  152.             }  
  153.             $asFolderPath = ""  
  154.             $asFolderPath = (GetFolderPath -EWSFolder $ffFolder)  
  155.             "FolderPath : " + $asFolderPath  
  156.             $collectVal = $null  
  157.             if($ffFolder.TryGetProperty($CollectionIdProp,[ref]$collectVal)){  
  158.                 $HexEntryId = [System.BitConverter]::ToString($collectVal).Replace("-","").Substring(2)  
  159.                 $ewsFolderId = ConvertId -HexId ($HexEntryId.SubString(0,($HexEntryId.Length-2)))  
  160.                 try{  
  161.                     $fldReport = "" | Select Mailbox,Device,AsFolderPath,MailboxFolderPath,LastModified  
  162.                     $fldReport.Mailbox = $MailboxName  
  163.                     $fldReport.Device = $fldMappingHash[$ffFolder.ParentFolderId.UniqueId].DisplayName  
  164.                     $fldReport.AsFolderPath = $asFolderPath  
  165.                     $folderMapId= new-object Microsoft.Exchange.WebServices.Data.FolderId($ewsFolderId)     
  166.                     $MappedFolder = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderMapId,$psPropertySet)  
  167.                     $MappedFolderPath = (GetFolderPath -EWSFolder $MappedFolder)  
  168.                     $fldReport.MailboxFolderPath = $MappedFolderPath  
  169.                     $LastModifiedVal = $null  
  170.                     if($ffFolder.TryGetProperty($LastModifiedTime,[ref]$LastModifiedVal)){  
  171.                         Write-Host ("Last-Modified : " +  $LastModifiedVal.ToLocalTime().ToString())  
  172.                         $fldReport.LastModified = $LastModifiedVal.ToLocalTime().ToString()  
  173.                     }  
  174.                     Write-Host $MappedFolderPath  
  175.                     $AsFolderReport += $fldReport  
  176.                 }  
  177.                 catch{  
  178.                       
  179.                 }  
  180.                 $ewsFolderId  
  181.             }  
  182.             #Process folder here  
  183.         }   
  184.         $fvFolderView.Offset += $fiResult.Folders.Count  
  185.     }while($fiResult.MoreAvailable -eq $true)    
  186.       
  187.       
  188. }  
  189. $reportFile = "c:\temp\$MailboxName-asFolders.csv"  
  190. $AsFolderReport | Export-Csv -NoTypeInformation -Path $reportFile  
  191. Write-Host ("Report wrtten to " + $reportFile)  

3 comments:

Dmitriy said...

Hi, I have a mailbox with folders' names in Russian that causes MailboxFolderPath to be shown as question marks

MailboxFolderPath
\Inbox\????????????????
\Inbox\????????????????
\Inbox\????????????????\Sent

Can this be fixed?

Thanks in advance.

Glen Scales said...

Its sounds like your Output encoding is set to ASCII which is the default you can change this to Unicode see http://blogs.msdn.com/b/powershell/archive/2006/12/11/outputencoding-to-the-rescue.aspx

Cheers
Glen

Alex Burtt said...

Hi,

I am getting a 401 unatuhorized error when running. Which credentials do i need to use. Domain admin or any account with full access to the mailbox? And in what format? UPN - name@domain.com


ERROR:

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

Alex.