Skip to main content

Creating a new public folder and setting the permissions via EWS

I’ve had a couple of questions about this one based on a previous post that no-one really seemed to understand (oh and there was a bug in the code in post). Permissions aren't an easy subject and EWS doesn’t really give a straight forward method of manipulating ACL's but once you understand the basics its generally functional. It’s one thing you do need to dedicate some time too to get your logic right. I posted a calendar permissions helper for powershell a couple of months back I thought this would be a pretty simple task but when I started to test the library it ended up taking a numbers of hours to get the logic right. To summarize the things to watch out for when setting permission via EWS two important points are.
  • The first is that the ACE’s for the EWS security roles enumerations and Outlook roles don’t match. There are only sutle differences but if you need these roles to marry up in Outlook you need to include your own routines to do this.
  • When you want to modify,add or delete an ACE on a public folder (or a mailbox folder) do a GerFolder to retrieve the current ACL and make sure you build a new Permission set and populate it with the existing ACE’s and the add,or modified the ACE you want to change.

There’s a lot more detail you can go into but I think it just gets confusing as I would be just trying to repeat what I mentioned in the past but if you can understand those two points then this code will start making a little sense.

So the code basically creates a Subfolder under another subfolder under a Root Public folder. So the first part of the code is an enumeration section that first finds the root public folder and then traverses this Root folder to find the Subfolder which will be the parent of the new folder. It then creates a new folder and then after that it gets the permissions for the new folder and modifies them so that the default ACE has editor rights so all users can modify the contacts that are created in this folder. Adding or deleting ACE’s is pretty simple you just use a new PermissionType object. Well maybe simple once you’ve done it a few times.

I’ve put a download of the code here the code itself looks like

ExchangeServiceBinding esb = new ExchangeServiceBinding();
esb.RequestServerVersionValue = new RequestServerVersion();
esb.RequestServerVersionValue.Version = ExchangeVersionType.Exchange2007_SP1;
esb.Credentials = new NetworkCredential("username", "password","domain");
esb.Url = @"https://servername/EWS/Exchange.asmx";
DistinguishedFolderIdType parentFolder = new DistinguishedFolderIdType();
parentFolder.Id = DistinguishedFolderIdNameType.publicfoldersroot;
FolderIdType cfContactsFolder = FindFolder(esb, parentFolder, "ParentFolder", "Months");
CreateFolder(esb, cfContactsFolder, "Contacts-June");
GetContacts(esb, cfContactsFolder);
Console.WriteLine(cfContactsFolder.Id);
}
static FolderIdType FindFolder(ExchangeServiceBinding esb, DistinguishedFolderIdType fiFolderID, String pfRootFldName, String sfChildSub)
{
FolderIdType rvFolderID = new FolderIdType();
// Create the request and specify the travesal type
FindFolderType findFolderRequest = new FindFolderType();
findFolderRequest.Traversal = FolderQueryTraversalType.Shallow;

// Define the properties returned in the response
FolderResponseShapeType responseShape = new FolderResponseShapeType();
responseShape.BaseShape = DefaultShapeNamesType.Default;
findFolderRequest.FolderShape = responseShape;

// Identify which folders to search
DistinguishedFolderIdType[] folderIDArray = new DistinguishedFolderIdType[1];

folderIDArray[0] = new DistinguishedFolderIdType();
folderIDArray[0].Id = fiFolderID.Id;
// folderIDArray[0].ChangeKey = fiFolderID.ChangeKey;

//Add Restriction for DisplayName
RestrictionType ffRestriction = new RestrictionType();
IsEqualToType ieToType = new IsEqualToType();
PathToUnindexedFieldType diDisplayName = new PathToUnindexedFieldType();
diDisplayName.FieldURI = UnindexedFieldURIType.folderDisplayName;

FieldURIOrConstantType ciConstantType = new FieldURIOrConstantType();
ConstantValueType cvConstantValueType = new ConstantValueType();
cvConstantValueType.Value = pfRootFldName;
ciConstantType.Item = cvConstantValueType;
ieToType.Item = diDisplayName;
ieToType.FieldURIOrConstant = ciConstantType;
ffRestriction.Item = ieToType;
findFolderRequest.Restriction = ffRestriction;

// Add the folders to search to the request
findFolderRequest.ParentFolderIds = folderIDArray;
// Send the request and get the response
FindFolderResponseType findFolderResponse = esb.FindFolder(findFolderRequest);

// Get the response messages
ResponseMessageType[] rmta = findFolderResponse.ResponseMessages.Items;

foreach (ResponseMessageType rmt in rmta)
{
if (((FindFolderResponseMessageType)rmt).ResponseClass == ResponseClassType.Success)
{
FindFolderResponseMessageType ffResponse = (FindFolderResponseMessageType)rmt;
if (ffResponse.RootFolder.TotalItemsInView > 0)
{
foreach (BaseFolderType fld in ffResponse.RootFolder.Folders)
{
Console.WriteLine(fld.DisplayName.ToString());
if (fld.ChildFolderCount != 0)
{
rvFolderID = FindSubFolder(esb, fld, sfChildSub);
}
}


}
else
{ //handle no folder
}
}
else
{ //handle error
}

}
return rvFolderID;


}
static FolderIdType FindSubFolder(ExchangeServiceBinding esb, BaseFolderType pfParentFolder, String sfChildSub)
{
FolderIdType rvFolderID = new FolderIdType();
FolderType dd = new FolderType();
BaseFolderIdType bf = new FolderIdType();

// Create the request and specify the travesal type
FindFolderType findFolderRequest = new FindFolderType();
findFolderRequest.Traversal = FolderQueryTraversalType.Shallow;

// Define the properties returned in the response
FolderResponseShapeType responseShape = new FolderResponseShapeType();
responseShape.BaseShape = DefaultShapeNamesType.Default;
findFolderRequest.FolderShape = responseShape;

// Identify which folders to search
FolderIdType[] folderIDArray = new FolderIdType[1];

folderIDArray[0] = new FolderIdType();
folderIDArray[0] = pfParentFolder.FolderId;

// Add the folders to search to the request
findFolderRequest.ParentFolderIds = folderIDArray;
// Send the request and get the response
FindFolderResponseType findFolderResponse = esb.FindFolder(findFolderRequest);

// Get the response messages
ResponseMessageType[] rmta = findFolderResponse.ResponseMessages.Items;

foreach (ResponseMessageType rmt in rmta)
{
if (((FindFolderResponseMessageType)rmt).ResponseClass == ResponseClassType.Success)
{
FindFolderResponseMessageType ffResponse = (FindFolderResponseMessageType)rmt;
if (ffResponse.RootFolder.TotalItemsInView > 0)
{
foreach (BaseFolderType fld in ffResponse.RootFolder.Folders)
{
Console.WriteLine(fld.DisplayName.ToString());
if (fld.DisplayName == sfChildSub) { rvFolderID = fld.FolderId; };
if (fld.ChildFolderCount != 0 & rvFolderID.Id == null)
{
rvFolderID = FindSubFolder(esb, fld, sfChildSub);
}
}

}
else
{ //handle no folder
}
}
else
{ //handle error
}

}
return rvFolderID;


}
static void CreateFolder(ExchangeServiceBinding esb, FolderIdType pfParentFolder, String nfNewFolderName)
{
CreateFolderType cfCreateFolder = new CreateFolderType();
ContactsFolderType nfNewFolder = new ContactsFolderType();
nfNewFolder.DisplayName = nfNewFolderName;
TargetFolderIdType tfTargetFolder = new TargetFolderIdType();
cfCreateFolder.ParentFolderId = new TargetFolderIdType();
cfCreateFolder.ParentFolderId.Item = pfParentFolder;
cfCreateFolder.Folders = new ContactsFolderType[] { nfNewFolder };
CreateFolderResponseType cfResponse = esb.CreateFolder(cfCreateFolder);
FolderInfoResponseMessageType cfResponseMessage = (FolderInfoResponseMessageType)cfResponse.ResponseMessages.Items[0];
if (cfResponseMessage.ResponseClass == ResponseClassType.Success)
{
setPerms(esb, cfResponseMessage.Folders[0].FolderId);
}
else
{//handle Error }
}

}
static void setPerms(ExchangeServiceBinding esb, FolderIdType ffFolder) {

FolderResponseShapeType frFolderRShape = new FolderResponseShapeType();
frFolderRShape.BaseShape = DefaultShapeNamesType.AllProperties;

GetFolderType gfRequest = new GetFolderType();
gfRequest.FolderIds = new BaseFolderIdType[1] { ffFolder };
gfRequest.FolderShape = frFolderRShape;


GetFolderResponseType gfGetFolderResponse = esb.GetFolder(gfRequest);
ContactsFolderType cfCurrentFolder = null;
if (gfGetFolderResponse.ResponseMessages.Items[0].ResponseClass == ResponseClassType.Success)
{

cfCurrentFolder = (ContactsFolderType)((FolderInfoResponseMessageType)gfGetFolderResponse.ResponseMessages.Items[0]).Folders[0];

}
else
{//handle error
}

UserIdType auAceUser = new UserIdType();
auAceUser.DistinguishedUserSpecified = true;
auAceUser.DistinguishedUser = DistinguishedUserType.Default;

PermissionSetType cfCurrentPermsionsSet = cfCurrentFolder.PermissionSet;
PermissionSetType cfNewPermsionsSet = new PermissionSetType();
cfNewPermsionsSet.Permissions = new PermissionType[cfCurrentPermsionsSet.Permissions.Length];
for (int cpint = 0; cpint < distinguisheduser ="=" distinguisheduserspecified ="=" userid =" cfCurrentPermsionsSet.Permissions[cpint].UserId;" permissionlevel =" PermissionLevelType.Editor;" permissionlevel ="=" userid =" cfCurrentPermsionsSet.Permissions[cpint].UserId;" permissionlevel =" cfCurrentPermsionsSet.Permissions[cpint].PermissionLevel;" cfupdatefolder =" new" permissionset =" cfNewPermsionsSet;" upupdatefolderrequest =" new" fcfolderchanges =" new" cffolderid =" new" id =" cfCurrentFolder.FolderId.Id;" changekey =" cfCurrentFolder.FolderId.ChangeKey;" item =" cfFolderid;" cpperms =" new" cpfielduri =" new" fielduri =" UnindexedFieldURIType.folderPermissionSet;" item =" cpFieldURI;" item1 =" cfUpdateFolder;" updates =" new" folderchanges =" new" ufupdatefolderresponse =" esb.UpdateFolder(upUpdateFolderRequest);" responseclass ="=">

Labels:

Popular posts from this blog

Export calendar Items to a CSV file using Microsoft Graph and Powershell

For the last couple of years the most constantly popular post by number of views on this blog has been  Export calendar Items to a CSV file using EWS and Powershell closely followed by the contact exports scripts. It goes to show this is just a perennial issue that exists around Mail servers, I think the first VBS script I wrote to do this type of thing was late 90's against Exchange 5.5 using cdo 1.2. Now it's 2020 and if your running Office365 you should really be using the Microsoft Graph API to do this. So what I've done is create a PowerShell Module (and I made it a one file script for those that are more comfortable with that format) that's a port of the EWS script above that is so popular. This script uses the ADAL library for Modern Authentication (which if you grab the library from the PowerShell gallery will come down with the module). Most EWS properties map one to one with the Graph and the Graph actually provides better information on recurrences then...
Read more

Downloading a shared file from Onedrive for business using Powershell

I thought I'd quickly share this script I came up with to download a file that was shared using One Drive for Business (which is SharePoint under the covers) with Powershell. The following script takes a OneDrive for business URL which would look like https://mydom-my.sharepoint.com/personal/gscales_domain_com/Documents/Email%20attachments/filename.txt This script is pretty simple it uses the SharePoint CSOM (Client side object Model) which it loads in the first line. It uses the URI object to separate the host and relative URL which the CSOM requires and also the SharePointOnlineCredentials object to handle the Office365 SharePoint online authentication. The following script is a function that take the OneDrive URL, Credentials for Office365 and path you want to download the file to and downloads the file. eg to run the script you would use something like ./spdownload.ps1 ' https://mydom-my.sharepoint.com/personal/gscales_domain_com/Documents/Email%20attachments/filen...
Read more

Sending a MimeMessage via the Microsoft Graph using the Graph SDK, MimeKit and MSAL

One of the new features added to the Microsoft Graph recently was the ability to create and send Mime Messages (you have been able to get Message as Mime for a while). This is useful in a number of different scenarios especially when trying to create a Message with inline Images which has historically been hard to do with both the Graph and EWS (if you don't use MIME). It also opens up using SMIME for encryption and a more easy migration path for sending using SMTP in some apps. MimeKit is a great open source library for parsing and creating MIME messages so it offers a really easy solution for tackling this issue. The current documentation on Send message via MIME lacks any real sample so I've put together a quick console app that use MSAL, MIME kit and the Graph SDK to send a Message via MIME. As the current Graph SDK also doesn't support sending via MIME either there is a workaround for this in the future my guess is this will be supported.
Read more
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.