Get-EXORecipientPermission
This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module.
Use the Get-EXORecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Get-EXORecipientPermission
[-AccessRights <MultiValuedProperty>]
[-ResultSize <Unlimited>]
[-Trustee <String>]
[<CommonParameters>]
Get-EXORecipientPermission
[[-Identity] <String>]
[-AccessRights <MultiValuedProperty>]
[-ExternalDirectoryObjectId <Guid>]
[-PrimarySmtpAddress <String>]
[-ResultSize <Unlimited>]
[-Trustee <String>]
[-UserPrincipalName <String>]
[<CommonParameters>]
Description
This cmdlet is used to view/manage information about SendAs permissions that are configured for users in a cloud-based organization. Send As permission allows delegates to use the mailbox to send messages. After this permission is assigned to a delegate, any message that the delegate sends from the mailbox will appear to have been sent by the mailbox owner. However, this permission doesn't allow a delegate to sign in to the user's mailbox. It only allows users to open the mailbox. If this permission is assigned to a group, a message sent by the delegate will appear to have been sent by the group.
Examples
Example 1
Get-EXORecipientPermission -ResultSize 100
Above example returns recipient permission for first 100 mailbox users in the name sorted order.
Parameters
-AccessRights
The AccessRights parameter filters the results by permission. The only valid value for this parameter is SendAs.
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-ExternalDirectoryObjectId
The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID.
You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-Identity
The Identity parameter identifies the recipient that you want to view. The user or group specified by the Trustee parameter has Send As permissions on this recipient. You can specify any type of recipient, for example:
- Mailboxes
- Mail users
- Mail contacts
- Distribution groups
- Dynamic distribution groups
For the best performance, we recommend using the following values to identify the recipient:
- User ID or user principal name (UPN)
- GUID
Otherwise, you can use any value that uniquely identifies the mailbox. For example:
- Name
- Alias
- Distinguished name (DN)
- Domain\Username
- Email address
- LegacyExchangeDN
- SamAccountName
You can't use this parameter with the ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-PrimarySmtpAddress
The PrimarySmtpAddress identifies the recipient that you want to view by primary SMTP email address (for example, [email protected]).
You can't use this parameter with the ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-ResultSize
The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.
Type: | Unlimited |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-Trustee
The Trustee parameter filters the results by the user or group who has Send As permissions. You can specify the following types of users or groups:
- Mailbox users
- Mail users with a Microsoft account
- Security groups
You can use any value that uniquely identifies the user or group. For example:
- Name
- Alias
- Distinguished name (DN)
- Canonical DN
- Domain\Username
- Email address
- User Principal name (UPN)
You need to use this parameter with the Identity, PrimarySmtpAddress, UserPrincipalName, or ExternalDirectoryObjectId parameters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-UserPrincipalName
The UserPrincipalName parameter identifies the recipient that you want to view by UPN (for example, [email protected]).
You can't use this parameter with the ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Online |