Share via


Get-UMMailbox (RTM)

Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.

 

Applies to: Exchange Server 2007

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

Syntax

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

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

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

Detailed Description

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 following:

  • Exchange Recipient Administrator role

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

Parameters

Parameter Required Type Description

Anr

Optional

System.String

This parameter specifies a string on which to perform an ambiguous name resolution 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

Credential

Optional

System.Management.Automation.PSCredential

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

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Filter

Optional

System.String

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.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

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.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

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.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

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.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

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.

SortBy

Optional

System.String

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.

Input Types

Type Description

 

 

Return Types

Type Description

 

 

Errors

Error Description

 

 

Example

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