Set-UMMailboxPIN (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 Set-UMMailboxPIN cmdlet resets the PIN for a UM-enabled mailbox.
Syntax
Set-UMMailboxPIN -Identity <MailboxIdParameter> [-DomainController <Fqdn>] [-LockedOut <$true | $false>] [-NotifyEmail <String>] [-Pin <String>] [-PinExpired <$true | $false>]
Detailed Description
The Set-UMMailboxPIN cmdlet is used when a UM-enabled user has been locked out of their mailbox because they tried to log on by using an incorrect PIN multiple times or because they have forgotten their PIN. You can use this cmdlet to set the user's PIN. The new PIN must comply with the PIN policy rules that are specified on the user's mailbox policy. The new PIN will be sent to the user in e-mail, or sent to an alternative e-mail address. You can control whether the user must reset the PIN at logon, and if the mailbox will continue to be locked.
To run the Set-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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:
This parameter is required if the Instance parameter is not used. |
DomainController |
Optional |
.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. |
LockedOut |
Optional |
System.Boolean |
This parameter specifies whether the mailbox will continue to be locked. If set to |
NotifyEmail |
Optional |
System.String |
This parameter specifies the e-mail address to which the server will send the e-mail message that contains the PIN reset information. By default, the message is sent to the SMTP address of the enabled user. |
Pin |
Optional |
System.String |
This parameter specifies a new PIN for use with this mailbox. The PIN will be checked against the PIN rules that are defined in the UM policy. If the PIN is not supplied, the task will generate a new PIN for the mailbox and include it in an e-mail message sent to the user. |
PINExpired |
Optional |
System.Boolean |
This parameter specifies whether the PIN will be treated as expired. If this parameter is supplied and is set to |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Example
The first example resets the PIN on the UM-enabled mailbox for yanli@contoso.com.
The second example resets the initial PIN on the UM-enabled mailbox for yanli@contoso.com to 1985848 and then sets the PIN as expired so that the user will be asked to change the PIN the next time that they log on.
The third example locks the UM-enabled mailbox for yanli@contoso.com to prevent the user from accessing their mailbox.
The fourth example unlocks the UM-enabled mailbox for yanli@contoso.com and allows them to access to their mailbox.
Set-UMMailboxPIN -Identity yanli@contoso.com
Set-UMMailboxPIN -Identity yanli@contoso.com -PIN 1985848 -PinExpired $true
Set-UMMailboxPIN -Identity yanli@contoso.com -LockedOut $true
Set-UMMailboxPIN -Identity yanli@contoso.com -LockedOut $false