Set-UMMailbox — usage, script and reference

Quick start script

# Set-UMMailbox — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-UMMailbox
$before | Format-List

# 3. Make the change (dry run first)
Set-UMMailbox -Identity <MailboxIdParameter> -WhatIf
Set-UMMailbox -Identity <MailboxIdParameter>

# 4. Verify and diff
$after = Get-UMMailbox
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-UMMailbox [-Identity] <MailboxIdParameter>
 [-AllowUMCallsFromNonUsers <AllowUMCallsFromNonUsersFlags>]
 [-AnonymousCallersCanLeaveMessages <Boolean>]
 [-AutomaticSpeechRecognitionEnabled <Boolean>]
 [-CallAnsweringAudioCodec <AudioCodecEnum>]
 [-CallAnsweringRulesEnabled <Boolean>]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-FaxEnabled <Boolean>]
 [-IgnoreDefaultScope]
 [-ImListMigrationCompleted <Boolean>]
 [-MissedCallNotificationEnabled <Boolean>]
 [-Name <String>]
 [-OperatorNumber <String>]
 [-PinlessAccessToVoiceMailEnabled <Boolean>]
 [-PlayOnPhoneEnabled <Boolean>]
 [-SubscriberAccessEnabled <Boolean>]
 [-TUIAccessToCalendarEnabled <Boolean>]
 [-TUIAccessToEmailEnabled <Boolean>]
 [-UMMailboxPolicy <MailboxPolicyIdParameter>]
 [-UMSMSNotificationOption <UMSMSNotificationOptions>]
 [-VoiceMailAnalysisEnabled <Boolean>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (23)

Parameter	Type	Required	What it controls
-Identity	MailboxIdParameter	yes	The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example:
-AllowUMCallsFromNonUsers	AllowUMCallsFromNonUsersFlags		The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from Unified Messaging directory searches.
-AnonymousCallersCanLeaveMessages	Boolean		The AnonymousCallersCanLeaveMessages parameter specifies whether diverted calls without a caller ID are allowed to leave a message.
-AutomaticSpeechRecognitionEnabled	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...
-CallAnsweringAudioCodec	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	Boolean		The CallAnsweringRulesEnabled parameter specifies whether users can configure or set up Call Answering Rules for their accounts. The default value is $true.
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DomainController	Fqdn		The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name...
-FaxEnabled	Boolean		The FaxEnabled parameter specifies whether a user is allowed to receive incoming faxes.
-IgnoreDefaultScope	SwitchParameter		The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch.
-ImListMigrationCompleted	Boolean		The ImListMigrationCompleted parameter specifies whether the UM-enabled user's Lync or Skype for Business contact list is stored in their mailbox.
-MissedCallNotificationEnabled	Boolean		The MissedCallNotificationEnabled parameter specifies whether to send missed call notifications.
-Name	String		The Name parameter specifies the display name for the user. The display name is limited to 64 characters.
-OperatorNumber	String		The OperatorNumber parameter specifies the string of digits for the personal operator.
-PinlessAccessToVoiceMailEnabled	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	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	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...
-TUIAccessToCalendarEnabled	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...
-TUIAccessToEmailEnabled	Boolean		The TUIAccessToEmailEnabled parameter specifies whether users can access their individual email messages over the telephone. The default value is $true.
-UMMailboxPolicy	MailboxPolicyIdParameter		The UMMailboxPolicy parameter specifies the UM mailbox policy associated with the UM-enabled user's mailbox.
-UMSMSNotificationOption	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...
-VoiceMailAnalysisEnabled	Boolean		The VoiceMailAnalysisEnabled parameter specifies whether a copy of each voice mail left for a UM-enabled user is forwarded to Microsoft for analysis and improvement of speech recognition features.
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.