Applies to: Exchange Server 2007
Topic Last Modified: 2007-06-11

The Enable-UMMailbox cmdlet enables Unified Messaging (UM) for an existing mail-enabled user.

Syntax

Enable-UMMailbox -Identity <MailboxIdParameter> -UMMailboxPolicy <MailboxPolicyIdParameter> [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-DomainController <Fqdn>] [-Extensions <MultiValuedProperty>] [-NotifyEmail <String>] [-PilotNumber <String>] [-Pin <String>] [-PinExpired <$true | $false>] [-SIPResourceIdentifier <String>] [-ValidateOnly <SwitchParameter>]

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:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

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

UMMailboxPolicy

Required

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter specifies the name of the Unified Messaging mailbox policy to be associated with the user.

AutomaticSpeechRecognitionEnabled

Optional

System.Boolean

This parameter enables Automatic Speech Recognition (ASR) to be used with the UM mailbox. ASR is only available if the user's specified language preference is installed.

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.

Extensions

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the extension number for the user. Either a single extension number or an array of telephone number extensions can be specified. The user's extension must be unique to the UM dial plan. If this parameter is not included, a default telephone number value from Active Directory is used.

NotifyEmail

Optional

System.String

This parameter specifies the e-mail address to which the server will send the e-mail message that contains the Unified Messaging welcome information. By default, the message is sent to the SMTP address of the enabled user.

PilotNumber

Optional

System.String

This parameter specifies the subscriber access number that the user can dial to gain access to their mailbox. The default value is the subscriber access number that is specified on a Dial Plan object in Active Directory.

PIN

Optional

System.String

This parameter specifies the value for the initial PIN to be used with the UM mailbox. The PIN will be checked against the UM mailbox policy rules. The PIN value must be between 4-24 numeric characters. If no PIN is specified, a PIN generated by the system will be e-mailed to the user. The PIN generated by the system contains 6 numeric characters, the default.

PINExpired

Optional

System.Boolean

This parameter specifies whether the PIN will be treated as expired. If this parameter is supplied and is set to $false, the user will not be required to reset their PIN the next time that they log on. If the PIN is not supplied, the PIN will be treated as expired and the user will be prompted to reset their PIN the next time that they log on.

SIPResourceIdentifier

Optional

System.String

This parameter specifies the Session Initiation Protocol (SIP) address for the user. This property will be compared to the Uniform Resource Identifier (URI) format that is defined on the UM dial plan.

ValidateOnly

Optional

System.Management.Automation.SwitchParameter

This parameter specifies to check all the prerequisites needed to successfully run the cmdlet without actually performing an action.

Detailed Description

The Enable-UMMailbox cmdlet enables Unified Messaging for an existing mail-enabled Exchange 2007 user. When the mail-enabled user is enabled for Unified Messaging, the settings from a UM mailbox policy are applied to the user. After the user is enabled for Unified Messaging, they can use the UM features that are included with Exchange 2007.

To run the Enable-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.

Input Types

Type Description

 

 

Return Types

Type Description

 

 

Errors

Error Description

 

 

Example

The first example enables Unified Messaging on the mailbox for yanli@contoso.com, sets the extension and PIN for the user, and then assigns a UM mailbox policy named MyUMMailboxPolicy to the user’s mailbox.

The second example enables Unified Messaging on a SIP-enabled mailbox for yanli@contoso.com, associates a UM mailbox policy named MYUMMailboxPolicy, and sets the extension number, SIP Resource identifier, and PIN for the user.

Copy Code
Enable-UMMailbox -Identity yanli@contoso.com -UMMailboxPolicy MyUMMailboxPolicy -Extensions 51234 -PIN 5643892 -NotifyEmail administrator@contoso.com -PINExpired $true

Enable-UMMailbox -Identity yanli@contoso.com -UMMailboxPolicy MyUMMailboxPolicy -Extensions 51234 -PIN 5643892 -NotifyEmail administrator@contoso.com -SIPResourceIdentifier "yanli@contoso.com" -PINExpired $true