Commands › Exchange Online
Set-UMMailboxPolicy
Modify a Unified Messaging (UM) mailbox policy.
Quick start script
# Set-UMMailboxPolicy — 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-UMMailboxPolicy
$before | Format-List
# 3. Make the change (dry run first)
Set-UMMailboxPolicy -Identity <MailboxPolicyIdParameter> -WhatIf
Set-UMMailboxPolicy -Identity <MailboxPolicyIdParameter>
# 4. Verify and diff
$after = Get-UMMailboxPolicy
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-UMMailboxPolicy [-Identity] <MailboxPolicyIdParameter>
[-AllowAutomaticSpeechRecognition <Boolean>]
[-AllowCallAnsweringRules <Boolean>]
[-AllowCommonPatterns <Boolean>]
[-AllowDialPlanSubscribers <Boolean>]
[-AllowedInCountryOrRegionGroups <MultiValuedProperty>]
[-AllowedInternationalGroups <MultiValuedProperty>]
[-AllowExtensions <Boolean>]
[-AllowFax <Boolean>]
[-AllowMessageWaitingIndicator <Boolean>]
[-AllowMissedCallNotifications <Boolean>]
[-AllowPinlessVoiceMailAccess <Boolean>]
[-AllowPlayOnPhone <Boolean>]
[-AllowSMSNotification <Boolean>]
[-AllowSubscriberAccess <Boolean>]
[-AllowTUIAccessToCalendar <Boolean>]
[-AllowTUIAccessToDirectory <Boolean>]
[-AllowTUIAccessToEmail <Boolean>]
[-AllowTUIAccessToPersonalContacts <Boolean>]
[-AllowVoiceMailAnalysis <Boolean>]
[-AllowVoiceMailPreview <Boolean>]
[-AllowVoiceResponseToOtherMessageTypes <Boolean>]
[-Confirm]
[-DomainController <Fqdn>]
[-FaxMessageText <String>]
[-FaxServerURI <String>]
[-ForceUpgrade]
[-InformCallerOfVoiceMailAnalysis <Boolean>]
[-LogonFailuresBeforePINReset <Unlimited>]
[-MaxGreetingDuration <Int32>]
[-MaxLogonAttempts <Unlimited>]
[-MinPINLength <Int32>]
[-Name <String>]
[-PINHistoryCount <Int32>]
[-PINLifetime <Unlimited>]
[-ProtectAuthenticatedVoiceMail <DRMProtectionOptions>]
[-ProtectedVoiceMailText <String>]
[-ProtectUnauthenticatedVoiceMail <DRMProtectionOptions>]
[-RequireProtectedPlayOnPhone <Boolean>]
[-ResetPINText <String>]
[-SourceForestPolicyNames <MultiValuedProperty>]
[-UMDialPlan <UMDialPlanIdParameter>]
[-UMEnabledText <String>]
[-VoiceMailPreviewPartnerAddress <SmtpAddress>]
[-VoiceMailPreviewPartnerAssignedID <String>]
[-VoiceMailPreviewPartnerMaxDeliveryDelay <Int32>]
[-VoiceMailPreviewPartnerMaxMessageDuration <Int32>]
[-VoiceMailText <String>]
[-WhatIf]
[<CommonParameters>]Parameters (49)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | MailboxPolicyIdParameter | yes | The Identity parameter specifies the identifier for the UM mailbox policy being modified. This is the directory object ID for the UM mailbox policy. |
| -AllowAutomaticSpeechRecognition | Boolean | The AllowAutomaticSpeechRecognition parameter specifies whether users associated with the UM mailbox policy can use Automatic Speech Recognition (ASR). The default value is $true. | |
| -AllowCallAnsweringRules | Boolean | The AllowCallAnsweringRules parameter specifies whether users associated with the UM mailbox policy are allowed to configure or set up Call Answering Rules for their accounts. The default value is $true. | |
| -AllowCommonPatterns | Boolean | The AllowCommonPatterns parameter specifies whether to allow obvious PINs. Examples of obvious PINs include subsets of the telephone number, sequential numbers, or repeated numbers. If set to $false, sequential and... | |
| -AllowDialPlanSubscribers | Boolean | The AllowDialPlanSubscribers parameter specifies whether to let subscribers in a dial plan dial a number that resolves to another subscriber within the same dial plan. The default value is $true. | |
| -AllowedInCountryOrRegionGroups | MultiValuedProperty | The AllowedInCountryOrRegionGroups parameter specifies whether to let subscribers dial the list of in-country/region dial group names. The names that subscribers are allowed to dial must match the group names defined... | |
| -AllowedInternationalGroups | MultiValuedProperty | The AllowedInternationalGroups parameter specifies whether to let subscribers dial the list of international dial group names. The names that subscribers dial must match the group names defined in the dial plan. | |
| -AllowExtensions | Boolean | The AllowExtensions parameter specifies whether to let subscribers dial calls to the number of digits specified on the UM dial plan. The default value is $true. | |
| -AllowFax | Boolean | The AllowFax parameter specifies whether users associated with the UM mailbox policy are allowed to receive incoming faxes. The default value is $true. | |
| -AllowMessageWaitingIndicator | Boolean | The AllowMessageWaitingIndicator parameter specifies whether users associated with the UM mailbox policy can receive notifications that they've received a new voice mail message. The default value is $true. | |
| -AllowMissedCallNotifications | Boolean | The AllowMissedCallNotifications parameter specifies whether missed call notifications are enabled for users associated with the UM mailbox policy. The default value is $true. | |
| -AllowPinlessVoiceMailAccess | Boolean | The AllowPinlessVoiceMailAccess parameter specifies whether users associated with the UM mailbox policy are required to use a PIN to access their voice mail. A PIN is still required to access their email and... | |
| -AllowPlayOnPhone | Boolean | The AllowPlayOnPhone parameter specifies whether users associated with the UM mailbox policy can use the Play on Phone feature to listen to voice mail messages. The default value is $true. | |
| -AllowSMSNotification | Boolean | The AllowSMSNotification parameter specifies whether UM-enabled users associated with the UM mailbox policy are allowed to get SMS or text messages sent to their mobile phones. If this parameter is set to $true, you... | |
| -AllowSubscriberAccess | Boolean | The AllowSubscriberAccess parameter specifies whether users associated with the UM mailbox policy are allowed subscriber access to their individual mailboxes. If this parameter is set to $true, after users are... | |
| -AllowTUIAccessToCalendar | Boolean | The AllowTUIAccessToCalendar parameter specifies whether users associated with the UM mailbox policy can access their individual calendars over the telephone. The default value is $true. | |
| -AllowTUIAccessToDirectory | Boolean | The AllowTUIAccessToDirectory parameter specifies whether users associated with the UM mailbox policy can access the directory over the telephone. The default value is $true. | |
| -AllowTUIAccessToEmail | Boolean | The AllowTUIAccessToEmail parameter specifies whether users associated with the UM mailbox policy can access their individual email messages over the telephone. The default value is $true. | |
| -AllowTUIAccessToPersonalContacts | Boolean | The AllowTUIAccessToPersonalContacts parameter specifies whether users associated with the UM mailbox policy can access their personal contacts over the telephone. The default value is $true. | |
| -AllowVoiceMailAnalysis | Boolean | The AllowVoiceMailAnalysis parameter specifies whether a copy of each voice mail is forwarded to Microsoft for analysis and improvement of our speech recognition features. | |
| -AllowVoiceMailPreview | Boolean | The AllowVoiceMailPreview parameter specifies whether users associated with the UM mailbox policy are able to receive Voice Mail Previews for call-answered messages, or have Voice Mail Previews provided for voice... | |
| -AllowVoiceResponseToOtherMessageTypes | Boolean | The AllowVoiceResponseToOtherMessageTypes parameter specifies whether UM-enabled users associated with the UM mailbox policy can record and attach a voice mail message when replying to email messages and calendar items. | |
| -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... | |
| -FaxMessageText | String | The FaxMessageText parameter specifies the text included in the body part of fax messages. This text is limited to 512 characters. | |
| -FaxServerURI | String | The FaxServerURI parameter specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) for the fax solution that serves the UM-enabled users associated with the UM mailbox policy. This fax... | |
| -ForceUpgrade | SwitchParameter | The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. | |
| -InformCallerOfVoiceMailAnalysis | Boolean | The InformCallerOfVoiceMailAnalysis parameter specifies whether callers leaving voice mails are informed about the possibility of their voice mails being forwarded to Microsoft for analysis. | |
| -LogonFailuresBeforePINReset | Unlimited | The LogonFailuresBeforePINReset parameter specifies the number of sequential unsuccessful logon attempts before the mailbox PIN is automatically reset. To disable this feature, set this parameter to Unlimited. If... | |
| -MaxGreetingDuration | Int32 | The MaxGreetingDuration parameter specifies the maximum greeting length. The range is from 1 through 10 minutes. The default value is 5 minutes. | |
| -MaxLogonAttempts | Unlimited | The MaxLogonAttempts parameter specifies the number of times users can try unsuccessfully to log on, in sequence, before the UM mailboxes are locked. The range is from 1 through 999. The default value is 15. | |
| -MinPINLength | Int32 | The MinPINLength parameter specifies the minimum number of digits required in a PIN for UM-enabled users. The range is from 4 through 24. The default value is 6. | |
| -Name | String | The Name parameter specifies the display name for the UM mailbox policy. This setting is limited to 64 characters. | |
| -PINHistoryCount | Int32 | The PINHistoryCount parameter specifies the number of previous PINs that are remembered and aren't allowed during a PIN reset. This number includes the first time that the PIN was set. The range is from 1 through 20.... | |
| -PINLifetime | Unlimited | The PINLifetime parameter specifies the number of days until a new password is required. The range is from 1 through 999. The default value is 60. If you specify Unlimited, the PINs don't expire. | |
| -ProtectAuthenticatedVoiceMail | DRMProtectionOptions | The ProtectAuthenticatedVoiceMail parameter specifies whether Mailbox servers that answer Outlook Voice Access calls for UM-enabled users associated with the UM mailbox policy create protected voice mail messages.... | |
| -ProtectedVoiceMailText | String | The ProtectedVoiceMailText parameter specifies the text included in the body part of the protected voice mail messages for UM-enabled users associated with the UM mailbox policy. This text can contain up to 512 characters. | |
| -ProtectUnauthenticatedVoiceMail | DRMProtectionOptions | The ProtectUnauthenticatedVoiceMail parameter specifies whether the Mailbox servers that answer calls for UM-enabled users associated with the UM mailbox policy create protected voice mail messages. This also applies... | |
| -RequireProtectedPlayOnPhone | Boolean | The RequireProtectedPlayOnPhone parameter specifies whether users associated with the UM mailbox policy can only use Play on Phone for protected voice mail messages or whether users can use multimedia software to... | |
| -ResetPINText | String | The ResetPINText parameter specifies the text to be included in the PIN reset email message. This text is limited to 512 characters. | |
| -SourceForestPolicyNames | MultiValuedProperty | The SourceForestPolicyNames parameter specifies the name or names of the corresponding UM mailbox policy objects located in the source forest during a cross-forest migration. | |
| -UMDialPlan | UMDialPlanIdParameter | The UMDialPlan parameter specifies the UM dial plan associated with the UM mailbox policy. | |
| -UMEnabledText | String | The UMEnabledText parameter specifies the text to be included when a user is enabled for Unified Messaging. This text is limited to 512 characters. | |
| -VoiceMailPreviewPartnerAddress | SmtpAddress | The VoiceMailPreviewPartnerAddress parameter specifies the SMTP address of a Voice Mail Preview partner that's contracted to provide transcription services for UM-enabled users in this UM mailbox policy. The default... | |
| -VoiceMailPreviewPartnerAssignedID | String | The VoiceMailPreviewPartnerAssignedID parameter specifies the identification string, if any, provided to the organization by the Voice Mail Preview partner that's contracted to provide transcription services for... | |
| -VoiceMailPreviewPartnerMaxDeliveryDelay | Int32 | The VoiceMailPreviewPartnerMaxDeliveryDelay parameter specifies the number of seconds that a Mailbox server waits for a Voice Mail Preview partner system to return a message with a Voice Mail Preview. If this time is... | |
| -VoiceMailPreviewPartnerMaxMessageDuration | Int32 | The VoiceMailPreviewPartnerMaxMessageDuration parameter specifies the maximum duration, in seconds, of voice mail messages sent to the Voice Mail Preview partner that's contracted to provide transcription services... | |
| -VoiceMailText | String | The VoiceMailText parameter specifies the text to be included in the body part of voice mail messages. The parameter applies to call answering messages in addition to messages originated by an authenticated... | |
| -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. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.