Get-EXORecipient

The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:

• CommonName (CN)
• DisplayName
• FirstName
• LastName
• Alias

You can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.

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 Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters.

The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax "Property -ComparisonOperator 'Value'".

• Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, $true, $false, or $null), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.
• Property is a filterable property. For more information about the filterable properties, see Get-EXORecipient property sets and Filterable properties for the Filter parameter.
• ComparisonOperator is an OPATH comparison operator (for example -eq for equals and -like for string comparison). For more information about comparison operators, see about_Comparison_Operators.
• Value is the property value to search for. Enclose text values and variables in single quotation marks ('Value' or '$Variable'). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of '$User', use '$($User -Replace "'","''")'. Don't enclose integers or system values in quotation marks (for example, use 500, $true, $false, or $null instead).

You can chain multiple search criteria together using the logical operators -and and -or. For example, "Criteria1 -and Criteria2" or "(Criteria1 -and Criteria2) -or Criteria3".

For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information.

The Identity parameter specifies the recipient object that you want to view. 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 recipient. For example:

• Name
• Alias
• Distinguished name (DN)
• Domain\Username
• Email address
• LegacyExchangeDN
• SamAccountName

You can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters.

The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.

Soft-deleted recipients are deleted recipients that are still recoverable.

The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:

• Name
• Canonical name
• Distinguished name (DN)
• GUID

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 Anr, ExternalDirectoryObjectId, Identity or UserPrincipalName parameters.

The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.

For more information about the available properties, see Get-EXORecipient property sets.

The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:

• Minimum (this is the default value)
• Archive
• Custom
• MailboxMove
• Policy

For more information about the properties that are included in each property set, see Get-EXORecipient property sets.

This parameter is reserved for internal Microsoft use.

The RecipientType parameter filters the results by the specified recipient type. Valid values are:

• DynamicDistributionGroup
• MailContact
• MailNonUniversalGroup
• MailUniversalDistributionGroup
• MailUniversalSecurityGroup
• MailUser
• PublicFolder
• UserMailbox

You can specify multiple values separated by commas.

The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are:

• DiscoveryMailbox
• DynamicDistributionGroup
• EquipmentMailbox
• GroupMailbox
• GuestMailUser
• LegacyMailbox
• LinkedMailbox
• LinkedRoomMailbox
• MailContact
• MailForestContact
• MailNonUniversalGroup
• MailUniversalDistributionGroup
• MailUniversalSecurityGroup
• MailUser
• PublicFolder
• PublicFolderMailbox
• RemoteEquipmentMailbox
• RemoteRoomMailbox
• RemoteSharedMailbox
• RemoteTeamMailbox
• RemoteUserMailbox
• RoomList
• RoomMailbox
• SchedulingMailbox
• SharedMailbox
• SharedWithMailUser
• TeamMailbox
• UserMailbox

You can specify multiple values separated by commas.

The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type.

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.

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 Anr, ExternalDirectoryObjectId, Identity, or PrimarySmtpAddress parameters.