Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-19
Use the Set-UMMailbox cmdlet to set the Unified Messaging (UM) properties for a user who is currently UM-enabled.
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>] [-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>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
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.
Parameters
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:
|
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
|
CallAnsweringAudioCodec |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.AudioCodecEnum |
The CallAnsweringAudioCodec parameter specifies the audio codec used to encode voice mail messages that are left for the user. The audio codec that's 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 |
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:
|
MissedCallNotificationEnabled |
Optional |
System.Boolean |
The MissedCallNotificationEnabled parameter specifies whether to send missed call notifications. |
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 e-mail and the
calendar. The default value is For more information, see Enable PIN-less Logons for UM-Enabled Users. |
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 |
SubscriberAccessEnabled |
Optional |
System.Boolean |
The SubscriberAccessEnabled parameter specifies whether
the users are allowed subscriber access to their individual
mailboxes. If it's set to |
TUIAccessToCalendarEnabled |
Optional |
System.Boolean |
The TUIAccessToCalendarEnabled parameter specifies
whether the UM-enabled user can access and manage their individual
calendar using the Microsoft Outlook Voice Access telephone user
interface (TUI) or touchtone interface. The default value is
|
TUIAccessToEmailEnabled |
Optional |
System.Boolean |
The TUIAccessToEmailEnabled parameter specifies whether
users can access their individual e-mail messages over the
telephone. The default value is |
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: |
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 cmdlet will verify that the phone number has been successfully registered in the global routing database. |
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. |
Input Types
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.
Return Types
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.
Examples
EXAMPLE 1
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
Copy Code | |
---|---|
Set-UMMailbox -Identity tony@contoso.com -CallAnsweringAudioCodec Wma -CallAnsweringRulesEnabled $false -FaxEnabled $false -UMSMSNotificationOption VoiceMail |
EXAMPLE 2
This example prevents the user tony@contoso.com from accessing his calendar and e-mail when he is using Outlook Voice Access.
Copy Code | |
---|---|
Set-UMMailbox -Identity tony@contoso.com -TUIAccessToCalendarEnabled $false -TUIAccessToEmailEnabled $false |