Friday, January 18, 2013

Creating a new Calendar,Contacts,Tasks or Notes Sub Folder in EWS with Powershell

I've had a few questions about this in the past week so I thought I would put together a quick sample to show how you can create a new Folder is EWS and set the FolderClass so it appears as a Calendar, Contacts, Tasks, Notes or whatever other folder you want. This is a function so you can just cut and paste it into your own script to use. The full script looks like the following which has samples of using the function at the bottom.

  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\1.2\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-Credhttp://www.blogger.com/blogger.g?blogID=7123450#editor/target=post;postID=2287688273890342518ential    
  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.   
  73. function Create-Folder{  
  74.     param (  
  75.             $ParentFolderID = "$( throw 'Enter Id of Parent Folder' )",  
  76.             $FolderName = "$( throw 'Enter Folder Name' )",  
  77.             $FolderClass = "$( throw 'Enter Folder Class IPF.Note,IPF.Appointment,IPF.Contact,IPF.Task' )"  
  78.           )  
  79.     process{  
  80.       
  81.     $NewFolder = new-object Microsoft.Exchange.WebServices.Data.Folder($service)    
  82.     $NewFolder.DisplayName = $FolderName    
  83.     $NewFolder.FolderClass = $FolderClass  
  84.     try{  
  85.         $NewFolder.Save($ParentFolderID)  
  86.         Write-Host $FolderName + " Folder Created "  
  87.     }  
  88.     catch{  
  89.         "Error : " + $Error[0]  
  90.     }  
  91.       
  92.     }  
  93. }  
  94. #Example use creating a Calendar subFolder  
  95. $ParentId = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Calendar,$MailboxName)     
  96. Create-Folder -ParentFolderID $ParentId -FolderName "New Calendar Folder Name" -FolderClass "IPF.Appointment"  
  97. #Example use creating a Contacts subFolder  
  98. $ParentId = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Contacts,$MailboxName)     
  99. Create-Folder -ParentFolderID $ParentId -FolderName "New Contact Folder Name" -FolderClass "IPF.Contact"  
  100. #Example use creating a Tasks subFolder  
  101. $ParentId = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Tasks,$MailboxName)     
  102. Create-Folder -ParentFolderID $ParentId -FolderName "New Tasks Folder Name" -FolderClass "IPF.Task"  
  103. #Example use creating a Notes subFolder  
  104. $ParentId = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Notes,$MailboxName)     
  105. Create-Folder -ParentFolderID $ParentId -FolderName "New Notes Folder Name" -FolderClass "IPF.StickyNote"  

8 comments:

Ondrej Ĺ ebela said...

This is really great, but now I try to figure out how to batch add shared calendar (pointing to some google calendar) via PS and EWS. I dont see any property as calendar web address or something similar.
Second thing is how to generally add shared calendar to users via PS and EWS.

Glen Scales said...

There is nothing in EWS that would make adding a shared calendars easy you would have to work with the Extended properties it creates when you add a shared calendar(its more an outlook function so you might want to look at the OOM).

Sorry I don't have any samples for this

Cheers
Glen

Anonymous said...

I receive this error when trying to run this script. Will someone tell me what I may have wrong.

[PS] C:\Windows\system32>./createcontactsubfolder.ps1 testlync2@xxxxxx.com
Error : Exception calling "Save" with "1" argument(s): "The specified folder could not be found in the store."

Glen Scales said...

That error means you don't have rights to the Mailbox your trying to create the Folder in. You need to assign full access via Add-MailoxPermissions

Cheers
Glen

Michael M said...

Will this work to create a new Calendar in the root of the Public Folder Mailbox? (Guess I am about to find out!)

flossenmann said...

Hello,

great script, thank you!Is it possible to create a contact folder in a public folder?

Thank you!

Glen Scales said...

Yes http://gsexdev.blogspot.com.au/2016/04/ews-bascis-accessing-public-folders-and.html

flossenmann said...

Thank you, but i don't get it. If i want to create a folder ($f.Save($ccFolder.Id)) i always get a error that the value is NULL. Creating a folder in a normal mailbox is possible, but how to do that in a public folder account?