Set-UMMailboxPolicy
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Set-UMMailboxPolicy cmdlet modifies a Unified Messaging (UM) mailbox policy.
Syntax
Set-UMMailboxPolicy -Identity <MailboxPolicyIdParameter> [-AllowCommonPatterns <$true | $false>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-AllowMissedCallNotifications <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-FaxID <String>] [-FaxMessageText <String>] [-LogonFailuresBeforePINReset <Unlimited>] [-MaxGreetingDuration <Int32>] [-MaxLogonAttempts <Unlimited>] [-MinPINLength <Int32>] [-Name <String>] [-PINHistoryCount <Int32>] [-PINLifetime <Unlimited>] [-ResetPINText <String>] [-UMDialPlan <UMDialPlanIdParameter>] [-UMEnabledText <String>] [-VoiceMailText <String>] [-WhatIf [<SwitchParameter>]]
Set-UMMailboxPolicy [-AllowCommonPatterns <$true | $false>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-AllowMissedCallNotifications <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-FaxID <String>] [-FaxMessageText <String>] [-Instance <UMMailboxPolicy>] [-LogonFailuresBeforePINReset <Unlimited>] [-MaxGreetingDuration <Int32>] [-MaxLogonAttempts <Unlimited>] [-MinPINLength <Int32>] [-Name <String>] [-PINHistoryCount <Int32>] [-PINLifetime <Unlimited>] [-ResetPINText <String>] [-UMDialPlan <UMDialPlanIdParameter>] [-UMEnabledText <String>] [-VoiceMailText <String>] [-WhatIf [<SwitchParameter>]]
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.
To run the Set-UMMailboxPolicy cmdlet, the account you use must be delegated the Exchange Organization Administrator role.
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter |
This parameter specifies the identifier for the UM mailbox policy that is being modified. This is the directory object ID for the UM mailbox policy. |
AllowCommonPatterns |
Optional |
System.Boolean |
This parameter specifies whether to allow obvious PINs. For example, subsets of the telephone number, sequential numbers, or repeated numbers. If set to |
AllowDialPlanSubscribers |
Optional |
System.Boolean |
This 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 is |
AllowedInCountryOrRegionGroups |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This 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 that are defined in the UM dial plan. The string is limited to 128 characters or fewer. |
AllowedInternationalGroups |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter specifies whether to let subscribers dial the list of international dial group names. The names subscribers dial must match the group names that are defined in the dial plan. |
AllowExtensions |
Optional |
System.Boolean |
This parameter specifies whether to let subscribers dial calls to the number of digits that are specified on the UM dial plan. The default is |
AllowMissedCallNotifications |
Optional |
System.Boolean |
This parameter specifies if missed call notifications will be enabled for users who are associated with the UM mailbox policy. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. The default value is $true. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service. |
FaxId |
Optional |
System.String |
This parameter specifies the fax identifier. |
FaxMessageText |
Optional |
System.String |
This parameter specifies the text that is included in the body part of fax messages. This text is limited to 512 characters. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.UMMailboxPolicy |
This parameter specifies the object input parameter. This parameter is required if the Identity parameter is not used. |
LogonFailuresBeforePINReset |
Optional |
Microsoft.Exchange.Data.Unlimited |
This parameter specifies the number of sequential unsuccessful logon attempts before the mailbox PIN is automatically reset. To disable this feature, set this parameter to |
MaxGreetingDuration |
Optional |
System.Int32 |
This parameter specifies the maximum greeting length. The range is 1 to 10 minutes. The default is 5 minutes. |
MaxLogonAttempts |
Optional |
Microsoft.Exchange.Data.Unlimited |
This parameter specifies the number of times a user can try unsuccessfully to log on, in sequence, before the UM mailbox is locked. The range is 1 to 999. The default is 15. |
MinPINLength |
Optional |
System.Int32 |
This parameter specifies the minimum number of digits that are required in a PIN for UM-enabled users. The range is 4 to 24. The default is 6. |
Name |
Optional |
System.String |
This parameter specifies the display name for the UM mailbox policy. This setting is limited to 64 characters. |
PINHistoryCount |
Optional |
System.Int32 |
This parameter specifies the number of previous PINs that will be remembered and will not be allowed during a PIN reset. This number includes the first time that the PIN was set. The range is 1 to 20. The default is 5. |
PINLifetime |
Optional |
Microsoft.Exchange.Data.Unlimited |
This parameter specifies the number of days until a new password is required. The range is 1 to 999. The default is 60. If you specify |
ResetPINText |
Optional |
System.String |
This 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 |
This parameter specifies the UM dial plan to associate with the UM mailbox policy. |
UMEnabledText |
Optional |
System.String |
This parameter specifies the text to be included in the UM-enabled e-mail message. This text is limited to 512 characters. |
VoiceMailText |
Optional |
System.String |
This parameter specifies the text to be included in the body part of voice messages. The parameter applies to call answering messages in addition to messages that are originated by an authenticated subscriber. This text is limited to 512 characters. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. The default value is $true. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first example sets the PIN settings for users that are associated with a UM mailbox policy named MyUMMailboxPolicy.
The second example selects the in-country or region groups and international groups from those configured on the UM dial plan that is associated with the UM mailbox policy. UM-enabled users associated with this UM mailbox policy will be able to place outbound calls according to the rules that are defined on these groups.
The third example configures the text of fax and voice messages that are sent to UM-enabled users and the text that is included in an e-mail that is sent to a user that has been UM-enabled.
Set-UMMailboxPolicy -identity MyUMMailboxPolicy -LogonFailuresBeforePINReset 8 -MaxLogonAttempts 12 -MinPINLength 8-PINHistoryCount 10 -PINLifetime 60 -ResetPINText "The PIN that is used to allow you access to your mailbox using Outlook Voice Access has been reset."
Set-UMMailboxPolicy -identity MyUMMailboxPolicy -AllowDialPlanSubscribers $true -AllowedInCountryOrRegionGroups InCountry/RegionGroup1,InCount/RegionGroup2 -AllowedInternationalGroups InternationalGroup1,InternationalGroup2 -AllowExtensions $true
Set-UMMailboxPolicy -identity MyUMMailboxPolicy -FaxID "Sent by Microsoft Exchange 2007 Unified Messaging." -FaxMessageText "You have received a fax message from Exchange 2007 Unified Messaging." -UMEnabledText "You have been enabled for Unified Messaging." -VoiceMailText "You have received a voice message from Microsoft Exchange 2007 Unified Messaging."