{"id":48,"date":"2013-04-22T18:21:38","date_gmt":"2013-04-22T14:21:38","guid":{"rendered":"http:\/\/use-powershell.com\/?p=48"},"modified":"2013-09-18T11:45:14","modified_gmt":"2013-09-18T07:45:14","slug":"using-folderid-permission-mailbox-folders","status":"publish","type":"post","link":"https:\/\/rakhesh.com\/powershell\/using-folderid-permission-mailbox-folders\/","title":{"rendered":"Using FolderID for permission related tasks on mailbox folders"},"content":{"rendered":"

It’s probably obvious – wasn’t for me and the help page doesn’t make it clear – but the (Add|Remove|Get)-MailboxFolderPermission<\/code> cmdlets don’t need a human readable path to the folder to do their deeds. <\/p>\n

If you look at the help page for the Get-MailboxFolderPermission<\/code> cmdlet it says the Identity<\/code> parameter takes input of the format <SMTP Address or Alias of the mailbox>:<Folder path><\/code> and gives as an example “john@contoso.com:Calendar”. This gave me the impression that I must pass the Folder path as a path to the folder and that there’s no other way of doing this. But that’s not the case. The Folder path can be a FolderID too.<\/p>\n

I haven’t managed to find much info on what a FolderID is, but if you want to find it for your own folders the easiest way is a cmdlet such as this:<\/p>\n

\r\nPS> Get-MailboxFolderStatistics rakhesh | ft FolderPath,FolderId -AutoSize\r\n\r\nFolderPath                                            FolderId\r\n----------                                            --------\r\n\/Top of Information Store                             LgAAAAB40\/hmKHlFR49TnSbER4JZAQChTLtNajpGTbet0ea4xu\/lAAAAcIikAAAB\r\n\/Calendar                                             LgAAAAB40\/hmKHlFR49TnSbER4JZAQChTLtNajpGTbet0ea4xu\/lAAAAcIWHAAAC\r\n\/Contacts                                             LgAAAAB40\/hmKHlFR49TnSbER4JZAQChTLtNajpGTbet0ea4xu\/lAAAAcIWIAAAD\r\n...\r\n<\/pre>\n
As far as I can tell slashes apart from the first one don’t seem to mean much (they don’t denote sub-folders at least). And there’s no easy way of identifying whether a folder is a sub-folder of another just by looking at the FolderID. <\/p>\n
I find it much better using FolderID to assign mailbox folder permissions recursively rather than using Folder path. <\/p>\n
With Folder paths I do something like this usually:<\/p>\n
\r\nPS> $mboxfolders = Get-MailboxFolderStatistics rakhesh\r\nPS> $mboxfolders | `\r\n# the where-object line is optional\r\nWhere-Object { $_.FolderPath -like \"\/Whatever*\" } | `\r\n%{ Get-MailboxFolderPermission $(($_.FolderPath -replace \"(.+)\",'rsasixp:$1') -replace '\/','') } | `\r\nfl FolderName,User,AccessRights\r\n\r\n\r\nFolderName   : Whatever\r\nUser         : Default\r\nAccessRights : {None}\r\n\r\nFolderName   : Whatever\r\nUser         : Anonymous\r\nAccessRights : {None}\r\n\r\nFolderName   : a) CCRs\r\nUser         : Default\r\nAccessRights : {None}\r\n\r\nFolderName   : a) CCRs\r\nUser         : Anonymous\r\nAccessRights : {None}\r\n\r\n...\r\n<\/pre>\n
The bit to note is line 4 where I do a bit of regexpery to convert the output from Get-MailboxFolderStatistics<\/code> to the format required by Get-MailboxFolderPermission<\/code>. The former returns Folder paths of the format \/path\/to\/folder<\/code> while the latter requires them to be <User>:<Folder path><\/code>. <\/p>\n
If I don’t use Folder paths, I can replace the above code with this:<\/p>\n
\r\nPS> $mboxfolders = Get-MailboxFolderStatistics rakhesh\r\nPS> $mboxfolders | `\r\n# the where-object line is optional\r\nWhere-Object { $_.FolderPath -like \"\/Whatever*\" } | `\r\n%{ Get-MailboxFolderPermission \"rsasixp:$($_.FolderId)\" } | `\r\nfl FolderName,User,AccessRights\r\n\r\n\r\nFolderName   : Whatever\r\nUser         : Default\r\nAccessRights : {None}\r\n\r\nFolderName   : Whatever\r\nUser         : Anonymous\r\nAccessRights : {None}\r\n\r\nFolderName   : a) CCRs\r\nUser         : Default\r\nAccessRights : {None}\r\n\r\nFolderName   : a) CCRs\r\nUser         : Anonymous\r\nAccessRights : {None}\r\n\r\n...\r\n<\/pre>\n
Much simpler looking code. And it also has a not so obvious advantage in that the previous code has a bug if the folder names contain the “\/” character. Have a look at the following:<\/p>\n
\r\nPS> Get-MailboxFolderStatistics rakhesh | ft FolderPath\r\n\r\nFolderPath\r\n----------\r\n\/Top of Information Store\r\n\/Calendar\r\n...\r\n\/Sent Items\/App[11111]\r\n\/Sent Items\/App[11111]\/Test ?123\r\n\/Sent Items\/App[11111]\/Test ?123\/[ab] ?12\r\n\/Suggested Contacts\r\n...\r\n<\/pre>\n
Notice the folders with a question mark in them? These appear because the folder name contains the “\/” character and since that’s used to separate folder paths the cmdlet replaces them with a “?” character. To get the code to work you’ll also have to replace the “?” character with a “\/”.  (The character is actually not a question mark, it is only displayed thus because the console cannot display what it properly. The character is actually ASCII\/UTF-8 code 63743 (hex code 0xF8FF) and you can match it with a regexp such as \"uF8FF\"<\/code>). <\/p>\n
If you use FolderID instead, you don’t have to worry about such fringe cases. <\/p>\n","protected":false},"excerpt":{"rendered":"
It’s probably obvious – wasn’t for me and the help page doesn’t make it clear – but the (Add|Remove|Get)-MailboxFolderPermission cmdlets don’t need a human readable path to the folder to do their deeds. If you look at the help page for the Get-MailboxFolderPermission cmdlet it says the Identity parameter takes input of the format <SMTP … Continue reading Using FolderID for permission related tasks on mailbox folders<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false}}},"categories":[2],"tags":[],"jetpack_publicize_connections":[],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts\/48"}],"collection":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/comments?post=48"}],"version-history":[{"count":0,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts\/48\/revisions"}],"wp:attachment":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/media?parent=48"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/categories?post=48"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/tags?post=48"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}