Export (0) Print
Expand All
Related Help Topics
Loading
No resources found.
Related Blog Articles
Loading
No resources found.
Expand Minimize

Set-OutlookProtectionRule

 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-19

Use the Set-OutlookProtectionRule cmdlet to modify an existing Microsoft Outlook protection rule.

CautionCaution:
Not specifying any conditions results in an Outlook protection rule being applied to all messages.


Set-OutlookProtectionRule -Identity <RuleIdParameter> [-ApplyRightsProtectionTemplate <RmsTemplateIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-FromDepartment <String[]>] [-Name <String>] [-Priority <Int32>] [-SentTo <MultiValuedProperty>] [-SentToScope <All | InOrganization>] [-UserCanOverride <$true | $false>] [-WhatIf [<SwitchParameter>]]

Outlook protection rules are used to automatically rights-protect e-mail messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see Understanding Outlook Protection Rules.

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 "Rights protection" entry in the Messaging Policy and Compliance Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter

The Identity parameter specifies the rule.

ApplyRightsProtectionTemplate

Optional

Microsoft.Exchange.Configuration.Tasks.RmsTemplateIdParameter

The ApplyRightsProtectionTemplate parameter specifies an RMS template to be applied to messages matching the conditions.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

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.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress the confirmation prompt produced by the cmdlet when modifying a rule with no conditions, resulting in such rules being applied to all messages.

FromDepartment

Optional

System.String[]

The FromDepartment parameter specifies a department name. The rule is applied to messages where the sender's department attribute matches this value.

Name

Optional

System.String

The Name parameter specifies a name for the rule.

Priority

Optional

System.Int32

The Priority parameter specifies a priority for the Outlook protection rule. Rule priority values can range from 0 through n-1, where n is the total number of existing Outlook protection rules.

Any existing rules with priority equal to or higher than the priority being set have their priority incremented by 1.

SentTo

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SentTo parameter specifies one or more recipients. External recipients can be specified using the SMTP address.

Internal recipients can be specified using any of the following values:

  • Alias

  • Distinguished name (DN)

  • ExchangeGUID

  • LegacyExchangeDN

  • SmtpAddress

  • User principal name (UPN)

SentToScope

Optional

Microsoft.Exchange.Management.OutlookProtectionRules.ToUserScope

The SentToScope parameter specifies the scope of messages to which the rule applies. Valid values include:

  • All   Applies to all messages.

  • InOrganization   Applies to messages originating from inside the Exchange organization, where all recipients are also internal.

If not specified, the parameter defaults to All.

UserCanOverride

Optional

System.Boolean

The UserCanOverride parameter specifies whether the Outlook user can override the rule behavior, either by using a different RMS template, or by removing rights protection, before sending the message. Valid values include:

  • $true   User can override rule action.

  • $false   User can't override rule action.

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.

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.

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.

This example modifies the Outlook protection rule OPR-DG-Finance to apply to messages sent to the DG-Finance distribution group.

Set-OutlookProtectionRule -Identity "OPR-DG-Finance" -SentTo "DG-Finance"

This example sets the priority of the Outlook protection rule OPR-DG-Finance to 2.

Set-OutlookProtectionRule -Identity "OPR-DG-Finance" -Priority 2
 © 2010 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft