Skip to main content

Changing Folder and Calendar Permissions in Exchange using the EWS Managed API and powershell

While Exchange 2010 provides some really good cmdlets now for setting and changing folder permissions such as Set-MailboxFolderPermission http://technet.microsoft.com/en-us/library/ff522363.aspx . Using EWS to do this can still be useful in circumstances where the cmdlets can't be used or your having problems with localized folder names or you want to take advantage of EWS Impersonation to get around any issues your having with acquiring the correct rights to make the changes you might need.

I'll look at the example of changing the default calendar permissions of the default ACL on the calendar as this is one of the harder things to do and there are a few points that can catch you out.

First point is that when you modify permissions with EWS you basically grab the DACL from the server make your changes locally to the DACL and the post it back in a Update Folder operation. This means the logic you use on the client side needs to be up to dealing with this. The permissions object in the Managed API has a Add and Remove methods and you have the ability to modify am ACE within the permissions collection. The one problem you can have is if the Folder permissions is currently set to custom and you try to use one the default FolderPermissionLevel. You will also have problem if you don't check the current collection and try to add a duplicate ACE into the collection.

A simple way to solve this is to first search the current collection for any existing ACE entries and remove the existing ACE then add the new rights you want set using the Add method. The other issue you need to deal with when setting the calendar folder permission is to also make sure you set the corresponding rights on the FreeBusy Data folder or you may have problems such as explained in http://support.microsoft.com/kb/184151

I've put together two examples both of these use EWS Impersonation which you can configure in 2010 via RBAC http://msdn.microsoft.com/en-us/library/bb204095%28v=EXCHG.140%29.aspx

There are 3 varibles in the script you need to modify

$MailboxName = "user@domain.com"




This is the mailbox you want to make the changes and what will be impersonated

$Permission = [Microsoft.Exchange.WebServices.Data.FolderPermissionLevel]::Editor






This is the rights you want to set

$credentials = New-Object System.Net.NetworkCredential("user@domain.com,"password")



These are the user credentials to use this user must have impersonation rights

I've posted both examples up here

In the first example this shows how to set the Default permissions for the default user on the Calendar to Editor


The second Example shows how to set calendar permission for a particular user to Editor this example looks like



  1. $MailboxName = "mailbox@domain.com"  
  2.   
  3.  
  1. $credentials = New-Object System.Net.NetworkCredential("user@domain.com","Password#")  
  2.   
  3. $NewACLUser = "newacl@domain.com"  
  4.   
  5. $dllpath = "C:\Program Files\Microsoft\Exchange\Web Services\1.1\Microsoft.Exchange.WebServices.dll"  
  6.   
  7. [void][Reflection.Assembly]::LoadFile($dllpath)  
  8.  
  9. $Permission = [Microsoft.Exchange.WebServices.Data.FolderPermissionLevel]::Editor  
  10.  
  11. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010)  
  12. $service.Credentials = $credentials  
  13. $service.AutodiscoverUrl($MailboxName,{$true})  
  14. $service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName);  
  15.   
  16.   
  17. function addFolderPerm($folder){  
  18.     $existingperm = $null  
  19.     foreach($fperm in $folder.Permissions){  
  20.         if($fperm.UserId.StandardUser -eq $null){  
  21.             if ($fperm.UserId.PrimarySmtpAddress.ToLower() -eq $NewACLUser.ToLower()){  
  22.                 $existingperm = $fperm  
  23.             }  
  24.         }  
  25.     }  
  26.     if($existingperm -ne $null){  
  27.         $folder.Permissions.Remove($existingperm)  
  28.     }   
  29.     $newfp = new-object Microsoft.Exchange.WebServices.Data.FolderPermission($NewACLUser,$Permission)  
  30.     $folder.Permissions.Add($newfp)  
  31.     $folder.Update()  
  32. }  
  33.   
  34. "Checking : " + $MailboxName   
  35. $folderidcnt = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Calendar,$MailboxName)  
  36. $Calendar = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderidcnt)  
  37. "Set Calendar Rights"  
  38. addFolderPerm($Calendar)  
  39. $sf1 = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo([Microsoft.Exchange.WebServices.Data.FolderSchema]::DisplayName,"Freebusy Data")  
  40.   
  41. $fvFolderView = New-Object Microsoft.Exchange.WebServices.Data.FolderView(1000)  
  42. $fvFolderView.Traversal = [Microsoft.Exchange.WebServices.Data.FolderTraversal]::Shallow;  
  43.   
  44. $folderidRoot = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Root,$MailboxName)  
  45. $fiResult = $Service.FindFolders($folderidRoot,$sf1,$fvFolderView)  
  46. if($fiResult.Folders.Count -eq 1){  
  47.     "Set FreeBusy Rights"  
  48.     $Freebusyfld = $fiResult.Folders[0]  
  49.     $Freebusyfld.Load()  
  50.     addFolderPerm($Freebusyfld)  
  51. }  

Popular posts from this blog

The MailboxConcurrency limit and using Batching in the Microsoft Graph API

If your getting an error such as Application is over its MailboxConcurrency limit while using the Microsoft Graph API this post may help you understand why. Background   The Mailbox  concurrency limit when your using the Graph API is 4 as per https://docs.microsoft.com/en-us/graph/throttling#outlook-service-limits . This is evaluated for each app ID and mailbox combination so this means you can have different apps running under the same credentials and the poor behavior of one won't cause the other to be throttled. If you compared that to EWS you could have up to 27 concurrent connections but they are shared across all apps on a first come first served basis. Batching Batching in the Graph API is a way of combining multiple requests into a single HTTP request. Batching in the Exchange Mail API's EWS and MAPI has been around for a long time and its common, for email Apps to process large numbers of smaller items for a variety of reasons.  Batching in the Graph is limited to a m

Sending a Message in Exchange Online via REST from an Arduino MKR1000

This is part 2 of my MKR1000 article, in this previous post  I looked at sending a Message via EWS using Basic Authentication.  In this Post I'll look at using the new Outlook REST API  which requires using OAuth authentication to get an Access Token. The prerequisites for this sketch are the same as in the other post with the addition of the ArduinoJson library  https://github.com/bblanchon/ArduinoJson  which is used to parse the Authentication Results to extract the Access Token. Also the SSL certificates for the login.windows.net  and outlook.office365.com need to be uploaded to the devices using the wifi101 Firmware updater. To use Token Authentication you need to register an Application in Azure https://msdn.microsoft.com/en-us/office/office365/howto/add-common-consent-manually  with the Mail.Send permission. The application should be a Native Client app that use the Out of Band Callback urn:ietf:wg:oauth:2.0:oob. You need to authorize it in you tenant (eg build a small ap

How to test SMTP using Opportunistic TLS with Powershell and grab the public certificate a SMTP server is using

Most email services these day employ Opportunistic TLS when trying to send Messages which means that wherever possible the Messages will be encrypted rather then the plain text legacy of SMTP.  This method was defined in RFC 3207 "SMTP Service Extension for Secure SMTP over Transport Layer Security" and  there's a quite a good explanation of Opportunistic TLS on Wikipedia  https://en.wikipedia.org/wiki/Opportunistic_TLS .  This is used for both Server to Server (eg MTA to MTA) and Client to server (Eg a Message client like Outlook which acts as a MSA) the later being generally Authenticated. Basically it allows you to have a normal plain text SMTP conversation that is then upgraded to TLS using the STARTTLS verb. Not all servers will support this verb so if its not supported then a message is just sent as Plain text. TLS relies on PKI certificates and the administrative issue s that come around certificate management like expired certificates which is why I wrote th
All sample scripts and source code is provided by for illustrative purposes only. All examples are untested in different environments and therefore, I cannot guarantee or imply reliability, serviceability, or function of these programs.

All code contained herein is provided to you "AS IS" without any warranties of any kind. The implied warranties of non-infringement, merchantability and fitness for a particular purpose are expressly disclaimed.