Monday, October 21, 2013

Exporting the Suggested Contacts, OWA Auto-complete Cache and Recipient Cache in Exchange 2013 with EWS and PowerShell

The following script creates a CSV export of Automatically generated contacts that have been saved in any of the 3 following auto contact locations

Suggested Contacts Folder which is Outlook feature that automatically creates a Contact for each address you send an email to - http://office.microsoft.com/en-au/outlook-help/automatically-add-contacts-for-everyone-that-you-send-an-email-message-HA101874367.aspx

OWA Autocomplete Cache - This is OWA version of the NickName cache, its stored in a UserConfiguration object in the Root of the Mailbox. The Addresses are stored inside an XML Streaming Property.

Recipeints Cache Folder - This is a new Exchange 2013 folder which is a hidden sub folder of the Contacts folder with a mailbox and it's purpose isn't really documented at the moment, but contains like the AutoComplete cache,  Addresses for Sent Emails.

So this script just create a CSV file with the Source, DisplayName and Email-address of any entries from these 3 locations.

I've put a download of this script 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\2.0\Microsoft.Exchange.WebServices.dll"    
  7.     
  8. ## Set Exchange Version    
  9. $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2013  
  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. $ExportCollection = @()  
  73. Write-Host "Process Recipient Cache"  
  74. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::RecipientCache,$MailboxName)     
  75. $RecipientCache = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  76.   
  77. $psPropset= new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)    
  78. #Define ItemView to retrive just 1000 Items      
  79. $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)      
  80. $fiItems = $null      
  81. do{      
  82.     $fiItems = $service.FindItems($RecipientCache.Id,$ivItemView)      
  83.     [Void]$service.LoadPropertiesForItems($fiItems,$psPropset)    
  84.     foreach($Item in $fiItems.Items){       
  85.         if($Item -is [Microsoft.Exchange.WebServices.Data.Contact]){  
  86.             $expObj = "" | select Source,DisplayName,Email1DisplayName,Email1Type,Email1EmailAddress  
  87.             $expObj.Source = "RecipientCache"  
  88.             $expObj.DisplayName = $Item.DisplayName  
  89.             if($Item.EmailAddresses.Contains([Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1)){                  
  90.                 $expObj.Email1DisplayName = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].Name  
  91.                 $expObj.Email1Type = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].RoutingType  
  92.                 $expObj.Email1EmailAddress = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].Address  
  93.             }  
  94.             $ExportCollection += $expObj  
  95.         }  
  96.     }      
  97.     $ivItemView.Offset += $fiItems.Items.Count      
  98. }while($fiItems.MoreAvailable -eq $true)   
  99.   
  100. Write-Host "Process Suggested Contacts"  
  101. $folderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::MsgFolderRoot,$MailboxName)   
  102. $fvFolderView = new-object Microsoft.Exchange.WebServices.Data.FolderView(1)  
  103. $SfSearchFilter = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo([Microsoft.Exchange.WebServices.Data.FolderSchema]::DisplayName,"Suggested Contacts")  
  104. $findFolderResults = $service.FindFolders($folderid,$SfSearchFilter,$fvFolderView)  
  105.   
  106. if($findFolderResults.Folders.Count -gt 0){  
  107.     $psPropset= new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)    
  108.     #Define ItemView to retrive just 1000 Items      
  109.     $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)      
  110.     $fiItems = $null      
  111.     do{      
  112.         $fiItems = $service.FindItems($findFolderResults.Folders[0].Id,$ivItemView)      
  113.         [Void]$service.LoadPropertiesForItems($fiItems,$psPropset)    
  114.         foreach($Item in $fiItems.Items){       
  115.             if($Item -is [Microsoft.Exchange.WebServices.Data.Contact]){  
  116.                 $expObj = "" | select Source,DisplayName,Email1DisplayName,Email1Type,Email1EmailAddress  
  117.                 $expObj.Source = "Suggested Contacts"  
  118.                 $expObj.DisplayName = $Item.DisplayName  
  119.                 if($Item.EmailAddresses.Contains([Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1)){                  
  120.                     $expObj.Email1DisplayName = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].Name  
  121.                     $expObj.Email1Type = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].RoutingType  
  122.                     $expObj.Email1EmailAddress = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].Address  
  123.                 }  
  124.                 $ExportCollection += $expObj  
  125.             }  
  126.         }      
  127.         $ivItemView.Offset += $fiItems.Items.Count      
  128.     }while($fiItems.MoreAvailable -eq $true)   
  129. }  
  130. Write-Host "Process OWA AutocompleteCache"  
  131. #$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName)$folderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Root,$MailboxName)   
  132. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Root,$MailboxName)       
  133. #Specify the Calendar folder where the FAI Item is    
  134. $UsrConfig = [Microsoft.Exchange.WebServices.Data.UserConfiguration]::Bind($service"OWA.AutocompleteCache"$folderid, [Microsoft.Exchange.WebServices.Data.UserConfigurationProperties]::All)    
  135. #Get the XML in String Format    
  136. $acXML = [System.Text.Encoding]::UTF8.GetString($UsrConfig.XmlData)    
  137. #Deal with the first character being a Byte Order Mark    
  138. $boMark = $acXML.SubString(0,1)    
  139. #Parse the XML    
  140. [XML]$acXML = $acXML.SubString(1)    
  141. foreach($AcEnt in $acXML.AutoCompleteCache.Entry){  
  142.     $expObj = "" | select Source,DisplayName,Email1DisplayName,Email1Type,Email1EmailAddress  
  143.     $expObj.Source = "OWA AutocompleteCache"  
  144.     $expObj.DisplayName = $AcEnt.displayName  
  145.     $expObj.Email1DisplayName= $AcEnt.displayName  
  146.     $expObj.Email1Type= "SMTP"  
  147.     $expObj.Email1EmailAddress= $AcEnt.smtpAddr  
  148.     $ExportCollection +=$expObj   
  149. }  
  150. $fnFileName = "c:\temp\" + $MailboxName + "AC-CacheExport.csv" 
  151. $ExportCollection | Export-Csv -NoTypeInformation -Path $fnFileName 
  152. "Exported to " + $fnFileName  

6 comments:

Marc said...

Method invocation failed because [Microsoft.Exchange.WebServices.Data.ContactsFolder] doesn't contain a method named 'Empty'

Any idea

Glen Scales said...

So I'll take that as a comment given this script doesn't call Empty I have no idea what your asking

Marc said...

Sorry I put my comment on the wrong page !
I adapted your other script to empty the suggestedcontcts folder to our environment but apparently the object [Microsoft.Exchange.WebServices.Data.ContactsFolder] has no method callled "empty" and therefore the script fails .
Do you want me to put the comment on the correct page ?

Glen Scales said...

ContactsFolder does have an empty method it depends on what version of the Managed API and version of Exchange your using. Its sounds like you version is to old.

Kintango Chibelabela said...

Hi! I've really been trying to find a way through this (esp with the second option) but I really don't know where to start. Can you please assist?

Anonymous said...

So this is all great, but how about explaining how to use this script? So it runs and prompts for credentials....any explanation as to what credentials it's asking for? Local PC, domain account, OWA login?....I've entered everything including incorrect credentials and the script just completes and does nothing, so apparently it does not verify the credentials (whatever it is looking for) and just assumes they are valid? So, how do you use this to be effective? I've got a CSV that is 0KB each time it runs....OWA has lots of suggested contacts, so what does this script do? I was hoping it would extract the Suggested Contacts from o365 OWA at outlook.office265.com OWA account but it is not pulling any data.