Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All



Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Topic Last Modified: 2015-03-09

The Get-UMMailbox cmdlet displays the Unified Messaging (UM) properties for a recipient who is UM-enabled.

Get-UMMailbox [-Identity <MailboxIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

Get-UMMailbox [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

Get-UMMailbox [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

The Get-UMMailbox cmdlet retrieves the UM properties for a single UM mailbox. It can also return a list of UM-enabled mailboxes.

To run the Get-UMMailbox cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.


Parameter Required Type Description




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

  • CommonName (CN)

  • DisplayName

  • FirstName

  • LastName

  • Alias




This parameter specifies the user name and password to use to access the Active Directory directory service.




This parameter specifies the fully qualified domain name of the domain controller that writes this configuration change to Active Directory.




This parameter lets you filter the results returned by the cmdlet.

For more information about the filterable properties, see Filterable Properties for the -Filter Parameter in Exchange 2007 RTM.




This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

This parameter is required if the Instance parameter is not used.




This parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell and use the entire forest as the scope. This allows the command to access Active Directory objects that are currently not in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You cannot use the DomainController parameter. The command will use an appropriate global catalog server automatically.

  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, are not accepted.

  • You cannot use the OrganizationalUnit and Identity parameters together.

  • You cannot use the Credential parameter.




This parameter specifies an organizational unit (OU) and is used to limit the results. If you use this parameter, you will retrieve only mailboxes in the container that you specify. You can use the OU or the domain name. If you use the OU, you must specify the canonical name of the OU.




This parameter specifies that the user information will be read from a domain controller in the user's domain. If you have set the recipient scope to include all recipients in the forest and if you do not use this parameter, the user information may be read from a global catalog whose information is outdated. If you do use this parameter, multiple reads may be necessary to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers.




This parameter lets you specify a maximum number of results to be returned. Otherwise a maximum number is not specified and the cmdlet will return all results.




This parameter specifies the attribute by which to sort the results. You can sort by only one attribute at a time. You can sort by the following attributes:

  • Alias

  • DisplayName

  • Name

The results will be sorted in ascending order.


Type Description




Type Description




Error Description



The first code example displays a list of all the UM-enabled mailboxes in the Active Directory forest in a formatted list.

The second code example displays the UM mailbox properties for yanli@contoso.com.

Get-UMMailbox | format-list

Get-UMMailbox -Identity yanli@contoso.com
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft