Set-CsOnlineUMMailBox

 

Topic Last Modified: 2016-08-21

Use the Set-CsOnlineUMMailBoxcmdlet to set the Unified Messaging (UM) properties for a user who is currently UM-enabled.

Set-CsOnlineUMMailBox -Identity <String> [-AirSyncNumbers <MultiValuedProperty>] [-AllowUMCallsFromNonUsers <None | SearchEnabled>] [-AnonymousCallersCanLeaveMessages <$true | $false>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringAudioCodec <G711 | Wma | Gsm | Mp3>] [-CallAnsweringRulesEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <String>] [-FaxEnabled <$true | $false>] [-Force <SwitchParameter>] [-IgnoreDefaultScope <SwitchParameter>] [-ImListMigrationCompleted <$true | $false>] [-MissedCallNotificationEnabled <$true | $false>] [-Name <String>] [-OperatorNumber <String>] [-PhoneNumber <String>] [-PhoneProviderId <String>] [-PinlessAccessToVoiceMailEnabled <$true | $false>] [-PlayOnPhoneEnabled <$true | $false>] [-SendWelcomeMail <$true | $false>] [-SubscriberAccessEnabled <$true | $false>] [-TenantId <Guid>] [-TUIAccessToCalendarEnabled <$true | $false>] [-TUIAccessToEmailEnabled <$true | $false>] [-UMMailboxPolicy <String>] [-UMSMSNotificationOption <None | VoiceMail | VoiceMailAndMissedCalls>] [-VerifyGlobalRoutingEntry <SwitchParameter>] [-VoiceMailAnalysisEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]

This example configures a UM-enabled user, tony@contoso.com with the following settings:

  • Changes the call answering audio codec to Wma

  • Disables call answering rules

  • Prevents him from receiving incoming faxes

  • Enables voice mail notifications but not missed call notifications using text messaging

Set-UMMailbox -Identity tony@contoso.com -TUIAccessToCalendarEnabled $false -TUIAccessToEmailEnabled $false

This example prevents the user tony@contoso.com from accessing his calendar and email when he's using UNRESOLVED_TOKEN_VAL(exOutlookNoVersionNoMk) Voice Access.

Set-UMMailbox -Identity tony@contoso.com -TUIAccessToCalendarEnabled $false -TUIAccessToEmailEnabled $false

The Set-UMMailbox cmdlet sets UM properties associated with a user who has been UM-enabled. Many of the UM properties for the user are stored on the user's mailbox, and other UM properties for the user are stored in UNRESOLVED_TOKEN_VAL(exADNoMk).

After this task is completed, the parameters and values specified are configured on the UM mailbox.

 

ParameterRequiredTypeDescription

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the user to enable for Unified Messaging. The values for this parameter include the following:

  • ADObjectID

  • GUID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

AllowUMCallsFromNonUsers

Optional

Microsoft.Exchange.Data.Directory.Recipient.AllowUMCallsFromNonUsersFlags

The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from directory searches.

AnonymousCallersCanLeaveMessages

Optional

System.Boolean

The AnonymousCallersCanLeaveMessages parameter specifies whether diverted calls without a caller ID are allowed to leave a message.

AutomaticSpeechRecognitionEnabled

Optional

System.Boolean

The AutomaticSpeechRecognitionEnabled parameter specifies whether users can use Automatic Speech Recognition (ASR) when they log on to their mailbox. This parameter can only be set to $true if there is ASR support for the language selected by the user in UNRESOLVED_TOKEN_VAL(exCoNameNoMk) UNRESOLVED_TOKEN_VAL(exOutlookOnTheWeb) Options.

CallAnsweringAudioCodec

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AudioCodecEnum

The CallAnsweringAudioCodec parameter specifies the audio codec used to encode voice mail messages left for the user. The audio codec used is the audio codec set on the UM dial plan. The default value is Mp3.

CallAnsweringRulesEnabled

Optional

System.Boolean

The CallAnsweringRulesEnabled parameter specifies whether users can configure or set up Call Answering Rules for their accounts. The default value is $true.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing, and requires confirmation to proceed.

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.

FaxEnabled

Optional

System.Boolean

The FaxEnabled parameter specifies whether a user is allowed to receive incoming faxes.

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.

Force

Optional

System.Management.Automation.SwitchParameter

Force's operation to complete.

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.

ImListMigrationCompleted

Optional

System.Boolean

The ImListMigrationCompleted parameter specifies whether the UM-enabled user's UNRESOLVED_TOKEN_VAL(exLyncNoVersion) or Skype for Business contact list is stored in their mailbox.

UNRESOLVED_TOKENBLOCK_VAL(PD_ImListMigrationCompleted)

MissedCallNotificationEnabled

Optional

System.Boolean

The MissedCallNotificationEnabled parameter specifies whether to send missed call notifications.

WarningWarning:
When you’re integrating Unified Messaging and Lync Server or Skype for Business Server, missed call notifications aren’t available to users who have mailboxes located on Exchange 2010 Mailbox servers. A missed call notification is generated when a user disconnects before the call is sent to a Mailbox server.

Name

Optional

System.String

The Name parameter specifies the display name for the user. The display name is limited to 64 characters.

OperatorNumber

Optional

System.String

The OperatorNumber parameter specifies the string of digits for the personal operator.

PhoneNumber

Optional

System.String

UNRESOLVED_TOKEN_VAL(PD_Cloud_Only_Parameter)

The PhoneNumber parameter specifies whether to assign a phone number to a UM-enabled user. This is only used for E.164 consumer dial plans.

PhoneProviderId

Optional

System.String

UNRESOLVED_TOKEN_VAL(PD_Cloud_Only_Parameter)

The PhoneProviderId parameter specifies the user's phone number and mobile service provider. This information is used to provide custom call forwarding and cancelling voice mail setup instructions based on the mobile phone provider.

PinlessAccessToVoiceMailEnabled

Optional

System.Boolean

The PinlessAccessToVoiceMailEnabled parameter specifies whether UM-enabled users are required to use a PIN to access their voice mail. A PIN is still required to access email and the calendar. The default value is $false.

PlayOnPhoneEnabled

Optional

System.Boolean

The PlayOnPhoneEnabled parameter specifies whether a user can use the Play on Phone feature to listen to voice messages. The default value is $true.

SubscriberAccessEnabled

Optional

System.Boolean

The SubscriberAccessEnabled parameter specifies whether the users are allowed subscriber access to their individual mailboxes. If it's set to $true, after users are authenticated, they're able to retrieve voice mail over the telephone. The default value is $true.

SendWelcomeMail

Optional

System.Boolean

SubscriberAccessEnabled

Optional

System.Boolean

TenantID

Optional

System.Guid

The tenant's ID.

TUIAccessToCalendarEnabled

Optional

System.Boolean

The TUIAccessToCalendarEnabled parameter specifies whether UM-enabled users can access and manage their individual calendar using the Microsoft UNRESOLVED_TOKEN_VAL(exOutlookNoVersionNoMk) Voice Access telephone user interface (TUI) or touchtone interface. The default value is $true.

TUIAccessToEmailEnabled

Optional

System.Boolean

The TUIAccessToEmailEnabled parameter specifies whether users can access their individual email messages over the telephone. The default value is $true.

UMMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The UMMailboxPolicy parameter specifies the UM mailbox policy associated with the UM-enabled user's mailbox.

UMSMSNotificationOption

Optional

Microsoft.Exchange.Data.Directory.Recipient.UMSMSNotificationOptions

The UMSMSNotificationOption parameter specifies whether a UM-enabled user gets SMS or text messaging notifications for voice mail only, voice mail and missed calls, or no notifications. The values for this parameter are: VoiceMail, VoiceMailAndMissedCalls, and None. The default value is None.

VerifyGlobalRoutingEntry

Optional

System.Management.Automation.SwitchParameter

UNRESOLVED_TOKEN_VAL(PD_Cloud_Only_Parameter)

The VerifyGlobalRoutingEntry parameter specifies the phone number has been successfully registered in the global routing database.

VoiceMailAnalysisEnabled

Optional

System.Boolean

The VoiceMailAnalysisEnabled parameter specifies whether a copy of each voice mail left for a UM-enabled user will be forwarded to Microsoft for analysis and improvement of speech recognition features.

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: