Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-07-11
Use the Get-MailUser cmdlet to retrieve the specified user's mail-related attributes from Active Directory.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-MailUser [-ArchiveDatabase
<DatabaseIdParameter>] <COMMON PARAMETERS>
|
Get-MailUser [-Anr <String>] <COMMON
PARAMETERS>
|
Get-MailUser [-Identity <MailUserIdParameter>]
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-AccountPartition
<AccountPartitionIdParameter>] [-Credential
<PSCredential>] [-DomainController <Fqdn>] [-Filter
<String>] [-IgnoreDefaultScope <SwitchParameter>]
[-Organization <OrganizationIdParameter>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController <SwitchParameter>] [-ResultSize
<Unlimited>] [-SoftDeletedMailUser <SwitchParameter>]
[-SortBy <String>] [-UsnForReconciliationSearch
<Int64>]
|
Examples
EXAMPLE 1
This example retrieves a complete list of mail-enabled users for the entire Exchange organization.
 Copy Code |
|
|---|---|
Get-MailUser |
|
EXAMPLE 2
This example retrieves the settings for the mail user named Ed, and then the command is piped to the Format-List cmdlet for display.
| Copy Code |
|
|---|---|
Get-MailUser -Identity Ed | Format-List |
|
Detailed Description
The Get-MailUser cmdlet retrieves all mail-related attributes of the specified user.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Recipient Provisioning Permissions" section in the Recipients Permissions topic.
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
AccountPartition |
Optional |
Microsoft.Exchange.Configuration.Tasks.AccountPartitionIdParameter |
This parameter is reserved for internal Microsoft use. |
||
|
Anr |
Optional |
System.String |
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:
|
||
|
ArchiveDatabase |
Optional |
Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter |
This parameter is reserved for internal Microsoft use. |
||
|
Credential |
Optional |
System.Management.Automation.PSCredential |
The Credential parameter specifies the account to use to gain access to Active Directory. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential. |
||
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
||
|
Filter |
Optional |
System.String |
The Filter parameter indicates the OPath filter used to filter recipients. For more information about the filterable properties, see Filterable Properties for the -Filter Parameter. |
||
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailUserIdParameter |
The Identity parameter identifies the user. This parameter accepts the following values:
|
||
|
IgnoreDefaultScope |
Optional |
System.Management.Automation.SwitchParameter |
The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:
|
||
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
||
|
OrganizationalUnit |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter |
The OrganizationalUnit parameter specifies a container in which to limit the results. You can specify either an organizational unit (OU) or a domain. The canonical name should be specified, for example:
|
||
|
ReadFromDomainController |
Optional |
System.Management.Automation.SwitchParameter |
The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you set the recipient scope to include all recipients in the forest and don't use this parameter, it's possible that the user information is read from a global catalog with outdated information. If you use this parameter, multiple reads might be necessary to get the information.
|
||
|
ResultSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ResultSize parameter specifies the maximum number of recipient objects to return. If not specified, the parameter returns all results that match the filter. |
||
|
SoftDeletedMailUser |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is reserved for internal Microsoft use. |
||
|
SortBy |
Optional |
System.String |
The SortBy parameter specifies the attribute by which to sort the results. Sorting is performed one attribute at a time and is always performed in ascending order. |
||
|
UsnForReconciliationSearch |
Optional |
System.Int64 |
This parameter is reserved for internal Microsoft use. |
Note:Input Types
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.
Return Types
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.