Get-EXOMailboxFolderPermission

This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Use the Exchange Online PowerShell V2 module (https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).

Use the Get-ExOMailboxFolderPermission cmdlet to view folder-level permissions in mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-server/exchange-cmdlet-syntax).

Syntax

Get-EXOMailboxFolderPermission
   [-User <String>]
   [-GroupMailbox]
   [[-Identity] <String>]
   [-ExternalDirectoryObjectId <Guid>]
   [-UserPrincipalName <String>]
   [<CommonParameters>]

Description

Use this cmdlet to retreive folder level permission in the mailbox. 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.

Examples

Example 1

Get-MailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports

This 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 Kim@contoso.com

This example returns the permissions for the same folder in John's mailbox, but only for the user Kim.

Parameters

-ExternalDirectoryObjectId

The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
Applies to:Exchange Online
-GroupMailbox

The GroupMailbox switch is required to return Office 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 Online
-Identity

The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: <Mailbox>:\<Folder>. For the value of <Mailbox>, you can use any value that uniquely identifies the mailbox. For example:

  • <UPN>:<FolderPath> (for examplejohn@contoso.com:\Calendar or John:\Marketing\Reports).

  • <ExternalDirectoryObjectId>:<FolderPath>

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
Applies to:Exchange Online
-User

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:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-UserPrincipalName

The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
Applies to:Exchange Online

Inputs

Outputs