Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-UMMailbox

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2012-11-05

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

For information about the parameter sets in the Syntax section below, see Syntax.

Set-UMMailbox -Identity <MailboxIdParameter> [-AirSyncNumbers <MultiValuedProperty>] [-AllowUMCallsFromNonUsers <None | SearchEnabled>] [-AnonymousCallersCanLeaveMessages <$true | $false>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringAudioCodec <G711 | Wma | Gsm | Mp3>] [-CallAnsweringRulesEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-FaxEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-ImListMigrationCompleted <$true | $false>] [-MissedCallNotificationEnabled <$true | $false>] [-Name <String>] [-OperatorNumber <String>] [-PhoneNumber <String>] [-PhoneProviderId <String>] [-PinlessAccessToVoiceMailEnabled <$true | $false>] [-PlayOnPhoneEnabled <$true | $false>] [-SubscriberAccessEnabled <$true | $false>] [-TUIAccessToCalendarEnabled <$true | $false>] [-TUIAccessToEmailEnabled <$true | $false>] [-UMMailboxPolicy <MailboxPolicyIdParameter>] [-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 -CallAnsweringAudioCodec Wma -CallAnsweringRulesEnabled $false -FaxEnabled $false -UMSMSNotificationOption VoiceMail

This example prevents the user tony@contoso.com from accessing his calendar and email when he's using Outlook 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 Active Directory.

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

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "UM mailboxes" entry in the Unified Messaging Permissions topic.

 

Parameter Required Type Description

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

AirSyncNumbers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AirSyncNumbers parameter specifies whether to register a mobile phone number with a hosted voice mail service. Each UM mailbox can have up to three numbers defined, and numbers must be in E.164 format.

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 Microsoft Office Outlook Web App 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 you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

FaxEnabled

Optional

System.Boolean

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

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter 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 distinguished name 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 a UM-enabled user's Microsoft Lync 2013 contact list has been successfully migrated from a user's Exchange mailbox to Lync 2013 servers and that the user's Microsoft Exchange Server 2013 mailbox can be migrated back to Exchange Server 2010.

For Lync 2013, the contact list for a Lync user can be stored in an Exchange 2013 user's mailbox called a Unified Contact Store (UCS). By storing the contact list in a user's mailbox, it allows applications to show a consistent, up-to-date list of the user's contact list.

If a user's mailbox is being migrated from Exchange 2013 to Exchange 2010, and the user is in UCS mode, the user's contact list must first be moved from their Exchange 2013 mailbox to Lync 2013 to preserve the user's contact list. This is the case because Exchange 2010 doesn't support the Exchange Web Services (EWS) methods used to support the UCS feature in Lync 2013.

A setting of $false indicates that a Lync user's contacts haven't been migrated. The default is $false.

MissedCallNotificationEnabled

Optional

System.Boolean

The MissedCallNotificationEnabled parameter specifies whether to send missed call notifications.

WarningWarning:
When you’re integrating Unified Messaging and Lync Server, missed call notifications aren’t available to users who have a mailbox located on an Exchange 2007 or Exchange 2010 Mailbox server. 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

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

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

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

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.

TUIAccessToCalendarEnabled

Optional

System.Boolean

The TUIAccessToCalendarEnabled parameter specifies whether UM-enabled users can access and manage their individual calendar using the Microsoft Outlook 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

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

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 instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.