Enable-CsOnlineUMMailBox

 

Topic Last Modified: 2016-08-21

Use the Enable-CsOnlineUMMailBox cmdlet to enable Unified Messaging (UM) for existing mailbox users.

Enable-CsOnlineUMMailBox -Identity <UserIdParameter> [-UMMailboxPolicy <String>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-DomainController <Fqdn>] [-Extensions <MultiValuedProperty>] [-Force <SwitchParameter>] [-IgnoreDefaultScope <SwitchParameter>] [-LineUri <UserIdParameter>] [-NotifyEmail <String>] [-PilotNumber <String>] [-Pin <String>] [-PinExpired <$true | $false>] [-SendWelcomeMail <$true | $false>] [-SIPResourceIdentifier <String>] [-TenantId <Guid>] [-ValidateOnly <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

This example enables Unified Messaging on the mailbox for tonysmith@contoso.com, sets the extension and PIN for the user that must be changed when the user logs on to UNRESOLVED_TOKEN_VAL(exOutlookNoVersionNoMk) Voice Access, assigns the UM mailbox policy MyUMMailboxPolicy to the user's mailbox, and then sends an email message that contains the Unified Messaging welcome information to administrator@contoso.com.

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

This example enables Unified Messaging on a SIP-enabled mailbox for tonysmith@contoso.com, associates the UM mailbox policy MyUMMailboxPolicy, and sets the extension number, SIP resource identifier, and PIN for the user that must be changed when the user logs on to UNRESOLVED_TOKEN_VAL(exOutlookNoVersionNoMk) Voice Access, and then sends an email message that contains the Unified Messaging welcome information to tonysmith@contoso.com.

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

When the mailbox is enabled for Unified Messaging, the settings from a UM mailbox policy are applied to the mailbox. After the mailbox is enabled for Unified Messaging, the user can use the UM features that are included in UNRESOLVED_TOKEN_VAL(exMSExchange).

 

ParameterRequiredTypeDescription

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox that you want to enable for Unified Messaging. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

AutomaticSpeechRecognitionEnabled

Optional

System.Boolean

The AutomaticSpeechRecognitionEnabled parameter specifies whether to enable Automatic Speech Recognition (ASR) for the UM mailbox. Valid values are:

  • $true   ASR is enabled for the mailbox. This is the default value. ASR is available only if the user's specified preferred language is installed.

  • $false   ASR is disabled for the mailbox.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name.

Extensions

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Extensions 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 you don't use this parameter, the command attempts to use a default telephone number value for the user. If you're using a Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) or E.164 dial plan, you also need to use the SIPResourceIdentifier parameter.

Force

Optional

System.Management.Automation.SwitchParameter

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Skype for Business Server.

The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access UNRESOLVED_TOKEN_VAL(exADNoMk) objects that aren't currently available in the default scope.

Using the IgnoreDefaultScope switch introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses 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, aren't accepted.

LineUri

Optional

System.Boolean

NotifyEmail

Optional

System.String

The NotifyEmail parameter specifies the email address where the Unified Messaging welcome message is sent. By default, the message is sent to the user's SMTP email address.

PilotNumber

Optional

System.String

The PilotNumber parameter specifies the subscriber access number users can dial to gain access to their mailboxes. The default value is the subscriber access number that's specified on the UM dial plan.

Pin

Optional

System.String

The PIN parameter specifies the value for the initial PIN that's used for the UM mailbox. The PIN is checked against the UM mailbox policy rules. The PIN value must be from 4 through 24 numeric characters.

If you don't use this parameter, a system-generated PIN is sent to the user. By default, the PIN generated by the system contains six numeric characters.

PinExpired

Optional

System.Boolean

The PINExpired parameter specifies whether the PIN is treated as expired. If the PIN isn't supplied, the PIN is treated as expired and users are prompted to reset their PIN the next time they log on.

  • $true   The user is required to reset their PIN the next time they log on.

  • $false   The user isn't required to reset their PIN the next time they log on.

SendWelcomeMail

Optional

System.Boolean

PARAMVALUE: $true | $false

SIPResourceIdentifier

Optional

System.String

The SIPResourceIdentifier parameter specifies the SIP address or E.164 address for the user. This property is compared to the URI type defined on the UM dial plan.

TenantID

Optional

System.Guid

UMMailBoxPolicy

Optional

System.String

ValidateOnly

Optional

System.Management.Automation.SwitchParameter

The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. No changes are made when the ValidateOnly switch is used.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes.

 
Show: