Export (0) Print
Expand All

Set-InboxRule

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Set-InboxRule cmdlet to modify an existing Inbox rule. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message.


set-InboxRule -Identity <InboxRuleIdParameter> [-ApplyCategory <MultiValuedProperty>] [-BodyContainsWords <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-CopyToFolder <MailboxFolderIdParameter>] [-DeleteMessage <$true | $false>] [-DomainController <Fqdn>] [-ExceptIfBodyContainsWords <MultiValuedProperty>] [-ExceptIfFlaggedForAction <Nullable>] [-ExceptIfFrom <RecipientIdParameter[]>] [-ExceptIfFromAddressContainsWords <MultiValuedProperty>] [-ExceptIfFromSubscription <AggregationSubscriptionIdentity[]>] [-ExceptIfHasAttachment <$true | $false>] [-ExceptIfHasClassification <MessageClassificationIdParameter[]>] [-ExceptIfHeaderContainsWords <MultiValuedProperty>] [-ExceptIfMessageTypeMatches <Nullable>] [-ExceptIfMyNameInCcBox <$true | $false>] [-ExceptIfMyNameInToBox <$true | $false>] [-ExceptIfMyNameInToOrCcBox <$true | $false>] [-ExceptIfMyNameNotInToBox <$true | $false>] [-ExceptIfReceivedAfterDate <Nullable>] [-ExceptIfReceivedBeforeDate <Nullable>] [-ExceptIfRecipientAddressContainsWords <MultiValuedProperty>] [-ExceptIfSentOnlyToMe <$true | $false>] [-ExceptIfSentTo <RecipientIdParameter[]>] [-ExceptIfSubjectContainsWords <MultiValuedProperty>] [-ExceptIfSubjectOrBodyContainsWords <MultiValuedProperty>] [-ExceptIfWithImportance <Nullable>] [-ExceptIfWithinSizeRangeMaximum <Nullable>] [-ExceptIfWithinSizeRangeMinimum <Nullable>] [-ExceptIfWithSensitivity <Nullable>] [-FlaggedForAction <Nullable>] [-Force <SwitchParameter>] [-ForwardAsAttachmentTo <RecipientIdParameter[]>] [-ForwardTo <RecipientIdParameter[]>] [-From <RecipientIdParameter[]>] [-FromAddressContainsWords <MultiValuedProperty>] [-FromSubscription <AggregationSubscriptionIdentity[]>] [-HasAttachment <$true | $false>] [-HasClassification <MessageClassificationIdParameter[]>] [-HeaderContainsWords <MultiValuedProperty>] [-Mailbox <MailboxIdParameter>] [-MarkAsRead <$true | $false>] [-MarkImportance <Nullable>] [-MessageTypeMatches <Nullable>] [-MoveToFolder <MailboxFolderIdParameter>] [-MyNameInCcBox <$true | $false>] [-MyNameInToBox <$true | $false>] [-MyNameInToOrCcBox <$true | $false>] [-MyNameNotInToBox <$true | $false>] [-Name <String>] [-Priority <Int32>] [-ReceivedAfterDate <Nullable>] [-ReceivedBeforeDate <Nullable>] [-RecipientAddressContainsWords <MultiValuedProperty>] [-RedirectTo <RecipientIdParameter[]>] [-SendTextMessageNotificationTo <MultiValuedProperty>] [-SentOnlyToMe <$true | $false>] [-SentTo <RecipientIdParameter[]>] [-StopProcessingRules <$true | $false>] [-SubjectContainsWords <MultiValuedProperty>] [-SubjectOrBodyContainsWords <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-WithImportance <Nullable>] [-WithinSizeRangeMaximum <Nullable>] [-WithinSizeRangeMinimum <Nullable>] [-WithSensitivity <Nullable>]

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.InboxRuleIdParameter

The Identity parameter specifies the name of the Inbox rule to be modified.

ApplyCategory

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ApplyCategory parameter specifies one or more categories to apply to a message.

BodyContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The BodyContainsWords parameter specifies one or more words or phrases to check the message body for. If phrases contain a space, you must enclose it in quotation marks ("). Use a comma to separate phrases.

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.

CopyToFolder

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxFolderIdParameter

The CopyToFolder parameter specifies the name of an existing mailbox folder to copy the message to.

DeleteMessage

Optional

System.Boolean

The DeleteMessage parameter specifies whether the message is sent to the Deleted Items folder. If set to $true, the DeleteMessage parameter specifies that the message is sent to the Deleted Items folder.

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.

ExceptIfBodyContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExceptIfBodyContainsWords parameter specifies one or more words or phrases to check the message body for. If the message body contains the specified words or phrases, the Inbox rule action isn't applied.

ExceptIfFlaggedForAction

Optional

System.Nullable

The ExceptIfFlaggedForAction parameter specifies one or more message flags to check the message for. Valid values include:

  • Any
  • Call
  • DoNotForward
  • FollowUp
  • ForYourInfo
  • Forward
  • NoResponseNecessary
  • Read
  • Reply
  • ReplyToAll
  • Review

ExceptIfFrom

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The ExceptIfFrom parameter specifies one or more senders. If the message sender matches the senders specified in this parameter, the Inbox rule action isn't applied.

ExceptIfFromAddressContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExceptIfFromAddressContainsWords parameter specifies one or more words to check the sender's address for. If the sender's address contains the specified words, the Inbox rule action isn't applied to the message.

ExceptIfFromSubscription

Optional

Microsoft.Exchange.Data.ContentAggregation.AggregationSubscriptionIdentity[]

This parameter is available only in the Outlook Live service.

The ExceptIfFromSubscription parameter specifies an exception when a message is received from a POP, IMAP, or Hotmail subscription.

ExceptIfHasAttachment

Optional

System.Boolean

The ExceptIfHasAttachment parameter specifies whether the message has attachments. Valid values include $true and $false.

ExceptIfHasClassification

Optional

Microsoft.Exchange.Configuration.Tasks.MessageClassificationIdParameter[]

The ExceptIfHasClassification parameter checks the message for the specified classification name. Use the Get-MessageClassification cmdlet to retrieve a list of classifications defined in the organization.

ExceptIfHeaderContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExceptIfHeaderContainsWords parameter specifies one or more values for a header.

ExceptIfMessageTypeMatches

Optional

System.Nullable

The ExceptIfMessageTypeMatches parameter specifies a message type. Valid values include one of the following:

  • AutomaticReply
  • AutomaticForward
  • Encrypted
  • Calendaring
  • CalendaringResponse
  • PermissionControlled
  • Voicemail
  • Signed
  • ApprovalRequest
  • ReadReceipt
  • NonDeliveryReport

ExceptIfMyNameInCcBox

Optional

System.Boolean

The ExceptIfMyNameInCcBox parameter specifies that the Cc field of messages is checked for the mailbox owner's address.

ExceptIfMyNameInToBox

Optional

System.Boolean

The ExceptIfMyNameInToBox parameter specifies that the To field of messages is checked for the mailbox owner's address.

ExceptIfMyNameInToOrCcBox

Optional

System.Boolean

The ExceptIfMyNameInToOrCcBox parameter specifies that the To or Cc field of messages is checked for the mailbox owner's address.

ExceptIfMyNameNotInToBox

Optional

System.Boolean

The ExceptIfMyNameNoteInToBox parameter matches messages where the mailbox owner isn't addressed in the To field of the message.

ExceptIfReceivedAfterDate

Optional

System.Nullable

The ExceptIfReceivedAfterDate specifies to check for messages received after the specified date.

ExceptIfReceivedBeforeDate

Optional

System.Nullable

The ExceptIfReceivedBeforeDate specifies to check for messages received before the specified date.

ExceptIfRecipientAddressContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExceptIfRecipientAddressContainsWords parameter specifies one or more words to check in the message recipient's address.

ExceptIfSentOnlyToMe

Optional

System.Boolean

The ExceptIfSentOnlyToMe parameter specifies to check for messages where the mailbox owner is the only recipient.

ExceptIfSentTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The ExceptIfSentTo parameter specifies to check message recipients for the recipient specified.

ExceptIfSubjectContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExceptIfSubjectContainsWords parameter specifies one or more words or phrases to check in the message subject.

ExceptIfSubjectOrBodyContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExceptIfSubjectOrBodyContainsWords parameter specifies one or more words or phrases to check in the message subject or body.

ExceptIfWithImportance

Optional

System.Nullable

The ExceptIfWithImportance parameter checks the message for the specified importance level. Valid values include:

  • High
  • Normal
  • Low

ExceptIfWithinSizeRangeMaximum

Optional

System.Nullable

The ExceptIfWithinSizeRangeMaximum parameter specifies a maximum message size. You must specify the minimum message size using the ExceptIfWithinSizeRangeMinimum parameter.

ExceptIfWithinSizeRangeMinimum

Optional

System.Nullable

The ExceptIfWithinSizeRangeMinimum parameter specifies a minimum message size. You must specify the maximum message size using the ExceptIfWithinSizeRangeMaximum parameter.

ExceptIfWithSensitivity

Optional

System.Nullable

The ExceptIfWithSensitivity parameter checks messages for the specified sensitivity level. Valid values include:

  • Normal
  • Personal
  • Private
  • CompanyConfidential

FlaggedForAction

Optional

System.Nullable

The FlaggedForAction parameter specifies one or more message flags to check the message for. Valid values include:

  • Any
  • Call
  • DoNotForward
  • FollowUp
  • ForYourInfo
  • Forward
  • NoResponseNecessary
  • Read
  • Reply
  • ReplyToAll
  • Review

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress the confirmation prompt produced if rules created by Outlook exist on the mailbox. When taking an action using Inbox rules on Exchange 2010, any client-side rules are removed.

ForwardAsAttachmentTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The ForwardAsAttachment parameter specifies a recipient to forward the message to as an attachment.

ForwardTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The ForwardTo parameter specifies the identity of a recipient to forward the message to.

From

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The From parameter specifies the identity of the sender as a rule condition.

FromAddressContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The FromAddressContainsWords parameter specifies one or more words to check in the From address of the message.

FromSubscription

Optional

Microsoft.Exchange.Data.ContentAggregation.AggregationSubscriptionIdentity[]

This parameter is available only in the Outlook Live service.

The FromSubscription parameter specifies the condition when a message is received from a POP, IMAP, or Hotmail, subscription.

HasAttachment

Optional

System.Boolean

The HasAttachment parameter specifies whether to check for messages with attachments.

HasClassification

Optional

Microsoft.Exchange.Configuration.Tasks.MessageClassificationIdParameter[]

The HasClassification parameter checks messages for the specified message classification.

HeaderContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The HeaderContainsWords parameter specifies one or more words to match in the specified message header.

Mailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter specifies the identity of the mailbox for which the new rule is being created. You can use the following values:

  • GUID
  • Distinguished name (DN)
  • Domain\Account
  • User principal name (UPN)
  • LegacyExchangeDN
  • SmtpAddress
  • Alias

MarkAsRead

Optional

System.Boolean

The MarkAsRead parameter specifies whether to mark the message as read. When set to $true, the MarkAsRead action marks the message as read.

MarkImportance

Optional

System.Nullable

The MarkImportance parameter specifies that the message importance be marked with one of the following values:

  • Low
  • Normal
  • High

MessageTypeMatches

Optional

System.Nullable

The MessageTypeMatches parameter specifies a message type to apply the rule to. Valid values include:

  • AutomaticReply
  • AutomaticForward
  • Encrypted
  • Calendaring
  • CalendaringResponse
  • PermissionControlled
  • Voicemail
  • Signed
  • ApprovalRequest
  • ReadReceipt
  • NonDeliveryReport

MoveToFolder

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxFolderIdParameter

The MoveToFolder parameter specifies an existing mailbox folder to which the message is copied.

MyNameInCcBox

Optional

System.Boolean

The MyNameInCcBox parameter specifies that the mailbox for which the rule is being created should appear in the Cc field of the message. To use this predicate, set the value to $true.

MyNameInToBox

Optional

System.Boolean

The MyNameInToBox parameter specifies that the mailbox for which the rule is being created should appear in the To field of the message. To use this predicate, set the value to $true.

MyNameInToOrCcBox

Optional

System.Boolean

The MyNameInToOrCcBox parameter specifies that the mailbox for which the rule is being created should appear in the To or Cc fields of the message. To add this condition, set the value to $true.

MyNameNotInToBox

Optional

System.Boolean

The MyNameNotInToBox parameter specifies that the mailbox for which the rule is being created should appear in the To field of the message. To use this predicate, set the value to $true.

Name

Optional

System.String

The Name parameter specifies a name for the Inbox rule.

Priority

Optional

System.Int32

The Priority parameter specifies a priority for the Inbox rule.

ReceivedAfterDate

Optional

System.Nullable

The ReceivedAfterDate parameter specifies a date. The rule is applied to messages received after the specified date.

ReceivedBeforeDate

Optional

System.Nullable

The ReceivedBeforeDate parameter specifies a date. The rule is applied only to messages received before the specified date.

RecipientAddressContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RecipientAddressContainsWords parameter specifies one or more words to check for in the recipient address.

RedirectTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The RedirectTo parameter specifies a recipient to redirect the message to.

SendTextMessageNotificationTo

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SendTextMessageNotificationTo parameter specifies one or more text message recipients to send a notification to.

SentOnlyToMe

Optional

System.Boolean

The SentOnlyToMe parameter specifies whether a message is sent only to the mailbox owner.

SentTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The SentTo parameter specifies the identity of a recipient as a condition.

StopProcessingRules

Optional

System.Boolean

The StopProcessingRules parameter specifies whether Exchange stops processing additional rules if the conditions of this Inbox rule are met. If set to $true, the StopProcessingRules parameter instructs Exchange to stop processing additional rules if the conditions of this Inbox rule are met.

SubjectContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SubjectContainsWords parameter specifies one or more keywords to be matched in the subject field of a message.

SubjectOrBodyContainsWords

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SubjectOrBodyContainsKeywords parameter specifies one or more keywords to be matched in the message subject or body.

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.

WithImportance

Optional

System.Nullable

The WithImportance parameter specifies that messages with the specified importance level are checked. Valid values include:

  • High
  • Normal
  • Low

WithinSizeRangeMaximum

Optional

System.Nullable

The WithinSizeRangeMaximum parameter specifies the maximum message size. When using this parameter, you must also specify a minimum message size value using the WithinSizeRangeMinimum parameter.

WithinSizeRangeMinimum

Optional

System.Nullable

The WithinSizeRangeMinimum parameter specifies the minimum size range. When using this parameter, you must also specify a maximum message size value using the WithinSizeRangeMaximum parameter.

WithSensitivity

Optional

System.Nullable

The WithSensitivity parameter specifies a message sensitivity level. Valid values include one of the following:

  • Normal
  • Personal
  • Private
  • CompanyConfidential

The Set-InboxRule cmdlet exposes rule predicates and actions, in addition to the parameters such as a rule name and the mailbox identity, required to create an Inbox rule.

Dd351089.important(en-us,EXCHG.140).gifImportant:
When you create, modify, remove, enable, or disable an Inbox rule on Microsoft Exchange Server 2010, any client-side rules created by Microsoft Outlook are removed.

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 "Inbox rules" entry in the Mailbox Permissions topic.

Error Description

 

This example modifies the action of the existing Inbox rule ProjectContoso. The MarkImportance parameter is used to mark the message with high importance.

Set-InboxRule ProjectContoso -MarkImportance "High"
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft