Enable-UMMailbox

  • Article

 

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

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

Syntax

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

Detailed Description

The Enable-UMMailbox cmdlet enables Unified Messaging (UM) for an existing mail-enabled Microsoft Exchange Server 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 Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange 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:

  • 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.

Confirm

Optional

System.Management.Automation.SwitchParameter

This parameter causes the command to pause processing and requires the administrator to acknowledge what the command will do before processing continues. The default value is $true.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service.

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.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

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 not currently 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.

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 Simple Mail Transfer Protocol (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 or E.164 address for the user. This property will be compared to the Uniform Resource Identifier (URI) type 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.

WhatIf

Optional

System.Management.Automation.SwitchParameter

This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, the administrator can view what changes would occur without having to apply any of those changes. The default value is $true.

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.

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