Tuesday, February 25, 2014

Exporting Contacts to a CSV file using the EWS Managed API and Powershell

Somebody asked last week about exporting contacts from Exchange via EWS to a CSV file and I realised I didn't have a basic sample for doing this. Contacts are one of the more richer exchange datatypes and can hold a lot of different information which you may or may not want to capture in a CSV export. In this sample script I'll show you how you can export data from the normal contact strongly typed properties like GivenName and Surname and the Indexed properties which are used to store the EmailAddresses, PhoneNumbers and Address details and also any extended properties like the Gender property which there are no strongly typed property for.

As I mentioned Contacts have a lot of properties so this script doesn't export everything just a subsection to show how to export properties from each of the different subgroups I talked about. To add other properties to script eg  like the JobTitle you need to make the following modifications

Add the property to the Custom object

$expObj = "" | select DisplayName,GivenName,Surname,Gender,Email1DisplayName,Email1Type,Email1EmailAddress,BusinessPhone,MobilePhone,HomePhone,BusinessStreet,BusinessCity,BusinessState,HomeStreet,HomeCity,HomeState,JobTitle

Then set the property within the Item Iteration

$expObj.JobTitle  = $item.JobTitle

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]::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. $ExportCollection = @()  
  73. Write-Host "Process Contacts"  
  74. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Contacts,$MailboxName)     
  75. $Contacts = [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. $PR_Gender = New-Object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(14925,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::Short)  
  79. $psPropset.Add($PR_Gender)  
  80.    
  81. #Define ItemView to retrive just 1000 Items      
  82. $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)      
  83. $fiItems = $null      
  84. do{      
  85.     $fiItems = $service.FindItems($Contacts.Id,$ivItemView)   
  86.     [Void]$service.LoadPropertiesForItems($fiItems,$psPropset)    
  87.     foreach($Item in $fiItems.Items){       
  88.         if($Item -is [Microsoft.Exchange.WebServices.Data.Contact]){  
  89.             $expObj = "" | select DisplayName,GivenName,Surname,Gender,Email1DisplayName,Email1Type,Email1EmailAddress,BusinessPhone,MobilePhone,HomePhone,BusinessStreet,BusinessCity,BusinessState,HomeStreet,HomeCity,HomeState  
  90.             $expObj.DisplayName = $Item.DisplayName  
  91.             $expObj.GivenName = $Item.GivenName  
  92.             $expObj.Surname = $Item.Surname  
  93.             $expObj.Gender = ""  
  94.             $Gender = $null  
  95.             if($item.TryGetProperty($PR_Gender,[ref]$Gender)){  
  96.                 if($Gender -eq 2){  
  97.                     $expObj.Gender = "Male"   
  98.                 }  
  99.                 if($Gender -eq 1){  
  100.                     $expObj.Gender = "Female"   
  101.                 }  
  102.             }  
  103.             $BusinessPhone = $null  
  104.             $MobilePhone = $null  
  105.             $HomePhone = $null  
  106.             if($Item.PhoneNumbers -ne $null){  
  107.                 if($Item.PhoneNumbers.TryGetValue([Microsoft.Exchange.WebServices.Data.PhoneNumberKey]::BusinessPhone,[ref]$BusinessPhone)){  
  108.                     $expObj.BusinessPhone = $BusinessPhone  
  109.                 }  
  110.                 if($Item.PhoneNumbers.TryGetValue([Microsoft.Exchange.WebServices.Data.PhoneNumberKey]::MobilePhone,[ref]$MobilePhone)){  
  111.                     $expObj.MobilePhone = $MobilePhone  
  112.                 }     
  113.                 if($Item.PhoneNumbers.TryGetValue([Microsoft.Exchange.WebServices.Data.PhoneNumberKey]::HomePhone,[ref]$HomePhone)){  
  114.                     $expObj.HomePhone = $HomePhone  
  115.                 }     
  116.             }             
  117.             if($Item.EmailAddresses.Contains([Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1)){                  
  118.                 $expObj.Email1DisplayName = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].Name  
  119.                 $expObj.Email1Type = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].RoutingType  
  120.                 $expObj.Email1EmailAddress = $Item.EmailAddresses[[Microsoft.Exchange.WebServices.Data.EmailAddressKey]::EmailAddress1].Address  
  121.             }  
  122.             $HomeAddress = $null  
  123.             $BusinessAddress = $null  
  124.             if($item.PhysicalAddresses -ne $null){  
  125.                 if($item.PhysicalAddresses.TryGetValue([Microsoft.Exchange.WebServices.Data.PhysicalAddressKey]::Home,[ref]$HomeAddress)){  
  126.                     $expObj.HomeStreet = $HomeAddress.Street  
  127.                     $expObj.HomeCity = $HomeAddress.City  
  128.                     $expObj.HomeState = $HomeAddress.State  
  129.                 }  
  130.                 if($item.PhysicalAddresses.TryGetValue([Microsoft.Exchange.WebServices.Data.PhysicalAddressKey]::Business,[ref]$BusinessAddress)){  
  131.                     $expObj.BusinessStreet = $BusinessAddress.Street  
  132.                     $expObj.BusinessCity = $BusinessAddress.City  
  133.                     $expObj.BusinessState = $BusinessAddress.State  
  134.                 }  
  135.             }  
  136.               
  137.             $ExportCollection += $expObj  
  138.         }  
  139.     }      
  140.     $ivItemView.Offset += $fiItems.Items.Count      
  141. }while($fiItems.MoreAvailable -eq $true)   
  142.   
  143. $fnFileName = "c:\temp\" + $MailboxName + "-ContactsExport.csv" 
  144. $ExportCollection | Export-Csv -NoTypeInformation -Path $fnFileName 
  145. "Exported to " + $fnFileName  

Adding an additional/Shared Mailbox to OWA with EWS and Powershell in Exchange 2013

The ability to add a shared Mailbox Folders was a feature that was introduced in Exchange 2010 and carried over into 2013. When an additional Mailbox folder is added this updates an XML configuration documented in the OWA.OtherMailbox FAI Item for this Mailbox.

In Exchange 2010 this includes an Id to the Folder but in Exchange2013/OWA it just includes the PrimarySMTP of the Mailbox your adding while the folderId is left blank. Due to this reason this script won't work on a Exchange 2010 server.

Note : Its important to point out even on 2013/Office365 this type of script that modifies the configuration item would also not be supported as it may inadvertently corrupt the config document so it's provided as is for testing only.

 The script to do this looks like

  1. ## Get the Mailbox to Access from the 1st commandline argument  
  2.   
  3. $MailboxName = $args[0]  
  4. $maMailboxToAdd = $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]::Exchange2013  
  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.   
  74. $exists = $false;  
  75. $updated = $false;  
  76. # Bind to the MsgFolderRoot folder    
  77. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Root,$MailboxName)     
  78. $Root = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  79. #Check for existing Item  
  80. $SfSearchFilter = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo([Microsoft.Exchange.WebServices.Data.ItemSchema]::ItemClass,"IPM.Configuration.OWA.OtherMailbox")  
  81. $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)  
  82. $ivItemView.Traversal =  [Microsoft.Exchange.WebServices.Data.ItemTraversal]::Associated  
  83. $fiResults = $service.FindItems($Root.Id,$SfSearchFilter,$ivItemView)  
  84. if($fiResults.Items.Count -eq 0){  
  85.     Write-Host ("No Config Item found, create new Item")  
  86.     $UMConfig = New-Object Microsoft.Exchange.WebServices.Data.UserConfiguration -ArgumentList $service  
  87.     $UMConfig.Save("OWA.OtherMailbox",$Root.Id)  
  88. }  
  89. else{  
  90.     Write-Host ("Existing Config Item Found");  
  91. }  
  92. $owaOtherMailbox = [Microsoft.Exchange.WebServices.Data.UserConfiguration]::Bind($service"OWA.OtherMailbox"$Root.Id, [Microsoft.Exchange.WebServices.Data.UserConfigurationProperties]::All);  
  93. #Make sure the server is running 2013 this script doesn't work on Exchange 2010  
  94. if($service.service.ServerInfo.MajorVersion -ge 15){  
  95.     $xmlConfig = New-Object System.Xml.XmlDocument  
  96.     if ($owaOtherMailbox.XmlData -eq $null)  
  97.     {  
  98.        $xmlConfig.LoadXml("<OtherMailbox></OtherMailbox>");  
  99.     }  
  100.     else  
  101.      {  
  102.        $xmlConfig.LoadXml([System.Text.UTF8Encoding]::UTF8.GetString($owaOtherMailbox.XmlData));  
  103.     }  
  104.     if($xmlConfig.OtherMailbox.entry -ne $null){  
  105.         foreach($obMailbox in  $xmlConfig.OtherMailbox.entry){  
  106.             Write-host ("Processing Mailbox : " + $obMailbox.principalSMTPAddress);  
  107.             if($obMailbox.principalSMTPAddress -eq $maMailboxToAdd.ToLower()){  
  108.                 $exists = $true;  
  109.             }  
  110.         }  
  111.     }  
  112.     if (!$exists)  
  113.     {  
  114.       $ncCol = $service.ResolveName($maMailboxToAdd,[Microsoft.Exchange.WebServices.Data.ResolveNameSearchLocation]::DirectoryOnly,$true);  
  115.       if ($ncCol.Count -gt 0)  
  116.        {  
  117.             $newmb = $xmlConfig.CreateElement("entry");  
  118.             $newmb.SetAttribute("displayName"$ncCol[0].Contact.DisplayName);  
  119.             $newmb.SetAttribute("rootFolderId""");  
  120.             $newmb.SetAttribute("principalSMTPAddress"$ncCol[0].Mailbox.Address);  
  121.             $newmb.InnerText = "";  
  122.             $xmlConfig.DocumentElement.AppendChild($newmb);  
  123.             $updated = $true;  
  124.        }  
  125.     }  
  126.     else  
  127.     {  
  128.         write-host ("Mailbox already added");  
  129.     }                 
  130.   
  131.     if ($updated) {  
  132.         $xmlbytes = [System.Text.UTF8Encoding]::UTF8.GetBytes($xmlConfig.OuterXml);  
  133.         $owaOtherMailbox.XmlData = $xmlbytes;  
  134.         $owaOtherMailbox.Update();  
  135.         write-host ("Config updated")  
  136.     }  
  137. }  



Thursday, February 13, 2014

MEC is back again this year

MEC the Microsoft Exchange Conference is on again this year in April and is shaping up to be a not to be missed event if your interested in Exchange. Unlike other conferences MEC doesn't come around every year which adds to the charm and freshness of the content you can expect to hear. Also the Exchange community are pretty awesome so it is not just the technology that makes this event but rather the people you can meet and listen to.

If your a developer or interested in coding on Exchange there is an Exchange Extensibility track http://www.mecisback.com/Sessions.aspx which covers among other things some of the new things you can do with Exchange 2013 and Exchange Online.  As with many of the sessions at MEC a lot these are being delivered by the people at Microsoft who are responsible for designing and delivering these features, so its one of the only places you can get those hard questions answered or put some feedback forward. The future look sessions also look pretty interesting to get glimpse of the near future.

I'm also really excited about the session I'll be giving at MEC on "Using Exchange as a platform for Innovation" http://www.mecisback.com/SessionDetail.aspx?id=14161 . My session content will be a bit out of the box and different, it might be a bit of an 11 on the technical side as i have a pretty broad scope to cover, I'll be talking on both hardware and software and how you can build Mailbox centric solutions on unconventional devices. So if your interested in what you can do with a Raspberry Pi connecting to an Exchange Mailbox with EWS or interesting in learning how the Maker movement may start interfacing with Exchange then this is the session for you. I hope to have a least 3 unique prototypes to show and a little bit of usually blog type scripts at the end.

You can get all the other details on MEC at http://www.mecisback.com/