Tuesday, February 25, 2014

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. }