Set-UMMailboxPolicy: Exchange 2010 Help

Set-UMMailboxPolicy -Identity <MailboxPolicyIdParameter> [-AllowAutomaticSpeechRecognition <$true | $false>] [-AllowCallAnsweringRules <$true | $false>] [-AllowCommonPatterns <$true | $false>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-AllowFax <$true | $false>] [-AllowMessageWaitingIndicator <$true | $false>] [-AllowMissedCallNotifications <$true | $false>] [-AllowPinlessVoiceMailAccess <$true | $false>] [-AllowPlayOnPhone <$true | $false>] [-AllowSMSNotification <$true | $false>] [-AllowSubscriberAccess <$true | $false>] [-AllowTUIAccessToCalendar <$true | $false>] [-AllowTUIAccessToDirectory <$true | $false>] [-AllowTUIAccessToEmail <$true | $false>] [-AllowTUIAccessToPersonalContacts <$true | $false>] [-AllowVoiceMailPreview <$true | $false>] [-AllowVoiceResponseToOtherMessageTypes <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-FaxMessageText <String>] [-FaxServerURI <String>] [-ForceUpgrade <SwitchParameter>] [-LogonFailuresBeforePINReset <Unlimited>] [-MaxGreetingDuration <Int32>] [-MaxLogonAttempts <Unlimited>] [-MinPINLength <Int32>] [-Name <String>] [-PINHistoryCount <Int32>] [-PINLifetime <Unlimited>] [-ProtectAuthenticatedVoiceMail <None | Private | All>] [-ProtectedVoiceMailText <String>] [-ProtectUnauthenticatedVoiceMail <None | Private | All>] [-RequireProtectedPlayOnPhone <$true | $false>] [-ResetPINText <String>] [-UMDialPlan <UMDialPlanIdParameter>] [-UMEnabledText <String>] [-VoiceMailPreviewPartnerAddress <Nullable>] [-VoiceMailPreviewPartnerAssignedID <String>] [-VoiceMailPreviewPartnerMaxDeliveryDelay <Int32>] [-VoiceMailPreviewPartnerMaxMessageDuration <Int32>] [-VoiceMailText <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter	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	Optional	System.Boolean	The AllowAutomaticSpeechRecognition parameter specifies whether users associated with the UM mailbox policy can use Automatic Speech Recognition (ASR). The default value is `$true`.
AllowCommonPatterns	Optional	System.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 repeated numbers and the suffix of the mailbox extension are rejected. If set to `$true`, only the suffix of the mailbox extension is rejected.
AllowDialPlanSubscribers	Optional	System.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	Optional	Microsoft.Exchange.Data.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 in the UM dial plan. The string is limited to 128 characters.
AllowedInternationalGroups	Optional	Microsoft.Exchange.Data.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.
AllowCallAnsweringRules	Optional	System.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`.
AllowExtensions	Optional	System.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	Optional	System.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	Optional	System.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	Optional	System.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	Optional	System.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 e-mail and calendar. The default value is `$false`.
AllowPlayOnPhone	Optional	System.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	Optional	System.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 also want to set the Set-UMMailbox cmdlet UMSMSNotificationOption parameter for the UM-enabled user to either `voicemail` or `VoiceMailAndMissedCalls`. The default value is `$true`.
AllowSubscriberAccess	Optional	System.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 authenticated, they're able to retrieve voice mail over the telephone. The default value is `$true`.
AllowTUIAccessToCalendar	Optional	System.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	Optional	System.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	Optional	System.Boolean	The AllowTUIAccessToEmail parameter specifies whether users associated with the UM mailbox policy can access their individual e-mail messages over the telephone. The default value is `$true`.
AllowTUIAccessToPersonalContacts	Optional	System.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`.
AllowVoiceMailPreview	Optional	System.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 mail messages that they send to other users in their mailbox. The default value is `$true`.
AllowVoiceResponseToOtherMessageTypes	Optional	System.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 e-mail messages and calendar items.
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.
FaxMessageText	Optional	System.String	The FaxMessageText parameter specifies the text included in the body part of fax messages. This text is limited to 512 characters.
FaxServerURI	Optional	System.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 product or fax service accepts incoming fax calls that were redirected from Microsoft Exchange Server 2010 Unified Messaging servers and creates inbound fax messages for the UM-enabled users associated with the UM mailbox policy.
ForceUpgrade	Optional	System.Management.Automation.SwitchParameter	The ForceUpgrade parameter specifies whether you're prompted for confirmation before a UM mailbox policy is upgraded.
LogonFailuresBeforePINReset	Optional	Microsoft.Exchange.Data.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 this parameter isn't set to `Unlimited`, it must be set to less than the value of the MaxLogonAttempts parameter. The range is from 0 through 999. The default setting is 5.
MaxGreetingDuration	Optional	System.Int32	The MaxGreetingDuration parameter specifies the maximum greeting length. The range is from 1 through 10 minutes. The default value is 5 minutes.
MaxLogonAttempts	Optional	Microsoft.Exchange.Data.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	Optional	System.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	Optional	System.String	The Name parameter specifies the display name for the UM mailbox policy. This setting is limited to 64 characters.
PINHistoryCount	Optional	System.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. The default value is 5.
PINLifetime	Optional	Microsoft.Exchange.Data.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 users' PINs won't expire.
ProtectAuthenticatedVoiceMail	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.DRMProtectionOptions	The ProtectAuthenticatedVoiceMail parameter specifies whether Unified Messaging servers that answer Outlook Voice Access calls for UM-enabled users associated with the UM mailbox policy create protected voice mail messages. The default setting is `None`. This means that no protection is applied to voice mail messages. If the value is set to `Private`, only messages marked as private are protected. If the value is set to `All`, every voice mail message is protected.
ProtectedVoiceMailText	Optional	System.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	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.DRMProtectionOptions	The ProtectUnauthenticatedVoiceMail parameter specifies whether the Unified Messaging servers that answer calls for UM-enabled users associated with the UM mailbox policy create protected voice mail messages. This also applies when a message is sent from a UM auto attendant to a UM-enabled user associated with the UM mailbox policy. The default setting is `None`. This means that no protection is applied to voice mail messages. If the value is set to `Private`, only messages marked as private are protected. If the value is set to `All`, every voice mail message is protected.
RequireProtectedPlayOnPhone	Optional	System.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 play the protected message. The default value is `$false`. Users are able to use both methods to listen to protected voice mail messages.
ResetPINText	Optional	System.String	The ResetPINText parameter specifies the text to be included in the PIN reset e-mail message. This text is limited to 512 characters.
UMDialPlan	Optional	Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter	The UMDialPlan parameter specifies the UM dial plan associated with the UM mailbox policy.
UMEnabledText	Optional	System.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	Optional	System.Nullable	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 value is `$null`.
VoiceMailPreviewPartnerAssignedID	Optional	System.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 UM-enabled users in this UM mailbox policy. The default value is `$null`.
VoiceMailPreviewPartnerMaxDeliveryDelay	Optional	System.Int32	The VoiceMailPreviewPartnerMaxDeliveryDelay parameter specifies the number of seconds that a Unified Messaging server waits for a Voice Mail Preview partner system to return a message with a Voice Mail Preview. If this time is exceeded, the Unified Messaging server delivers the voice mail message without a preview. The default value is 1200. The minimum number for this parameter is 300.
VoiceMailPreviewPartnerMaxMessageDuration	Optional	System.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 for UM-enabled users in this UM mailbox policy. The default value is 180. The minimum number for this parameter is 60. This setting should be set equal to the maximum value that is allowed by the Voice Mail Preview partner.
VoiceMailText	Optional	System.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 subscriber. This text is limited to 512 characters.
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.

Detailed Description

When the Set-UMMailboxPolicy cmdlet is used to modify UM mailbox policy objects, you can change settings such as PIN policies, message text settings, and dialing restrictions for a single UM-enabled recipient or multiple UM-enabled recipients. UM mailbox policies are associated with UM-enabled mailboxes and can be configured to increase the level of security for UM-enabled users.

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

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 mailbox policies" entry in the Unified Messaging Permissions topic.

Input Types

Return Types

Errors

Error	Description

Exceptions

Exceptions	Description

Examples

EXAMPLE 1

This example sets the PIN settings for users associated with the UM mailbox policy MyUMMailboxPolicy.

Set-UMMailboxPolicy -Identity MyUMMailboxPolicy -LogonFailuresBeforePINReset 8 -MaxLogonAttempts 12 -MinPINLength 8 -PINHistoryCount 10 -PINLifetime 60 -ResetPINText "The PIN used to allow you access to your mailbox using Outlook Voice Access has been reset."

EXAMPLE 2

This example selects the in-country or region groups and international groups from those configured on the UM dial plan associated with the UM mailbox policy. UM-enabled users associated with this UM mailbox policy can place outbound calls according to the rules defined on these groups.

Set-UMMailboxPolicy -Identity MyUMMailboxPolicy -AllowDialPlanSubscribers $true -AllowedInCountryOrRegionGroups InCountry/RegionGroup1,InCountry/RegionGroup2 -AllowedInternationalGroups InternationalGroup1,InternationalGroup2 -AllowExtensions $true

EXAMPLE 3

This example configures the text of voice mail messages sent to UM-enabled users and the text included in an e-mail message sent to a user that's UM-enabled.

Set-UMMailboxPolicy -Identity MyUMMailboxPolicy -UMEnabledText "You have been enabled for Unified Messaging." -VoiceMailText "You have received a voice mail message from Microsoft Exchange 2010 Unified Messaging."

Site Feedback