N-central Help

Get Mailbox Folder Permissions

Query for permissions for one or all users on a specific mailbox folder.

Input Parameters

Name Type Required Description
User Name String Yes User name used to authenticate to the Office 365 web service.
Password Password Yes Password used to authenticate to the Office 365 web service.
Mailbox Email Address for permissions check String Yes The email address of the mailbox to get permissions on.
Path of the Mailbox folder String Yes The folder of the mailbox to get permissions on.
User Email Address String Yes Email address of the user to query for permissions on the specified mailbox.
User Rights Assignment String Yes The name of the access rights.

Output Parameters

Name Type Description
Permissions Array Array containing effective permissions.
Permissions Record Count Number The number of entries within the Permissions Array.
RunSpace ID String The Runspace ID of the Permissions entry.
Folder Name String The name of the folder with applied permissions.
Access Rights String Effective access rights name applied.
User String Name of user that has permissions on mailbox
Identity String Identity of the user that has permissions.
Is Valid Boolean Displays if the mailbox folder is valid or contains errors.
Result String String Object Execution Error Details.
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
User Name String Yes Office365Admin@ABC.onmicrosoft.com
Password Password Yes <link to start parameter>
Users Checkbox Yes

Optionally query for the permissions of ‘all users’ on the specified mailbox folder.

Optionally query for the permission of one specified user on the specified mailbox folder.

Mailbox Email Address for permissions check String Yes Mailbox1@ABC.onmicrosoft.com
Path of Mailbox Folder String Yes
  • Inbox
  • Inbox/subfolder
User Email Address String Yes User1@ABC.onmicrosoft.com
Access Rights Name Sting Yes Owner