Get-MailboxFolderPermission
Use the Get-MailboxFolderPermission cmdlet to view folder-level permissions in mailboxes. Note : In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderPermission cmdlet instead of this cmdlet. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
Syntax
Get-MailboxFolderPermission
[-Identity] <MailboxFolderIdParameter>
[-DomainController <Fqdn>]
[-User <MailboxFolderUserIdParameter>]
[-GroupMailbox]
[<CommonParameters>]Description
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Get-MailboxFolderPermission -Identity john@contoso.com:\Marketing\ReportsThis example returns the current list of user permissions for the Reports subfolder in the Marketing folder in John's mailbox.
Example 2
Get-MailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports -User Ayla@contoso.comThis example returns the permissions for the same folder in John's mailbox, but only for the user Ayla.
Example 3
Get-MailboxFolderPermission -Identity john@contoso.com:\Calendar -User Ayla@contoso.comThis example returns the permissions for the Calendar folder in John's mailbox, but only for the user Ayla.
Parameters
This parameter is available only in on-premises Exchange.
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
The Identity parameter specifies the mailbox folder that you want to view. The syntax is MailboxID:\ParentFolder[\SubFolder].
For the value of MailboxID, you can use any value that uniquely identifies the mailbox. For example:
Name
Alias
Distinguished name (DN)
Canonical DN
<domain name>\<account name>
Email address
GUID
LegacyExchangeDN
SamAccountName
User ID or user principal name (UPN)
Example values for this parameter are john@contoso.com:\Calendar or John:\Inbox\Reports.
| Type: | MailboxFolderIdParameter |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example:
Name
Alias
Distinguished name (DN)
Canonical DN
Email address
GUID
| Type: | MailboxFolderUserIdParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
Inputs
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
Outputs
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn't return data.