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

Topic Last Modified: 2015-03-09

The Get-UMMailboxPIN cmdlet returns information from a UM-enabled user's mailbox.

Get-UMMailboxPin [-Identity <MailboxIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>]

The Get-UMMailboxPIN cmdlet returns information that is calculated from the PIN data that is stored in encrypted form in the user’s mailbox. By using the Get-UMMailboxPIN cmdlet, you can view information from the user's mailbox. You can also use this cmdlet to show whether the mailbox or user access has been locked out.

To run the Get-UMMailboxPIN 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 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 specifies the identifier that can be used to retrieve information about the mailbox. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias




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 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. If a maximum number is not specified, the cmdlet will return all results.


Error Description




Exceptions Description



The first code example displays the Unified Messaging mailbox PIN properties for all UM-enabled users.

The second code example displays the Unified Messaging mailbox PIN related properties for

Get-UMMailboxPIN -Identity