Applies to: Exchange Server 2007
Topic Last Modified: 2007-06-11
The Get-UMMailboxPIN cmdlet returns information from a UM-enabled user's mailbox.
Syntax
Get-UMMailboxPin [-Identity <MailboxIdParameter>]
[-Credential <PSCredential>] [-DomainController <Fqdn>]
[-ReadFromDomainController <SwitchParameter>] [-ResultSize
<Unlimited>]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
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. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
This parameter specifies the identifier that can be used to retrieve information about the mailbox. The variables for this parameter include the following:
|
|
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. If a maximum number is not specified, the cmdlet will return all results. |
Detailed Description
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 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.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
|
Example
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 yanli@contoso.com.
 Copy Code |
|
|---|---|
Get-UMMailboxPIN |
|
| Copy Code |
|
|---|---|
Get-UMMailboxPIN -Identity yanli@contoso.com |
|