Edit

Share via

Set-SweepRule

Module:
Exchange PowerShell

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other.

Use the Set-SweepRule cmdlet to modify Sweep rules in mailboxes.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Default (Default) 

Set-SweepRule
    [-Identity] <SweepRuleIdParameter>
    [-Confirm]
    [-DestinationFolder <MailboxFolderIdParameter>]
    [-DomainController <Fqdn>]
    [-Enabled <Boolean>]
    [-ExceptIfFlagged <Boolean>]
    [-ExceptIfPinned <Boolean>]
    [-KeepForDays <Int32>]
    [-KeepLatest <Int32>]
    [-Mailbox <MailboxIdParameter>]
    [-Name <String>]
    [-Provider <String>]
    [-Sender <RecipientIdParameter>]
    [-SourceFolder <MailboxFolderIdParameter>]
    [-SystemCategory <SystemCategoryType>]
    [-WhatIf]
    [<CommonParameters>]

Description

You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Set-SweepRule -Identity x2hlsdpGmUifjFgxxGIOJw== -KeepForDays 15 -ExceptIfPinned $true

This example modifies the existing rule that has the rule ID value x2hlsdpGmUifjFgxxGIOJw== with the specified value.

Parameters

-Confirm

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DestinationFolder

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The DestinationFolder parameter specifies an action for the Sweep rule that moves messages to the specified folder. The syntax is MailboxID:\ParentFolder[\SubFolder].

For the value of MailboxID, you can use any value that uniquely identifies the mailbox. For example:

  • Name
  • Alias
  • Distinguished name (DN)
  • Canonical DN
  • Domain\Username
  • Email address
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • User ID or user principal name (UPN)

Example values for this parameter are john@contoso.com:\Unimportant or John:\Inbox\Misc. The default value is MailboxID:\Deleted Items.

Parameter properties

Type:MailboxFolderIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DomainController

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

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 (FQDN). For example, dc01.contoso.com.

Parameter properties

Type:Fqdn
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Enabled

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

This parameter is reserved for internal Microsoft use.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExceptIfFlagged

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The ExceptIfFlagged parameter specifies an exception for the Sweep rule that looks messages with a message flag applied. Valid values are:

  • $true: The rule action isn't applied to messages that have a message flag applied.
  • $false: The exception isn't used.

The typical message flag values are:

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExceptIfPinned

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The PinMessage parameter specifies an exception for the Sweep rule that looks for pinned messages. Valid values are:

  • $true: The rule action isn't applied to messages that are pinned to the top of the Inbox.
  • $false: The exception isn't used.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The Identity parameter specifies the Sweep rule that you want to modify. You can use any value that uniquely identifies the rule. For example:

  • RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==).
  • Exchange Online: MailboxAlias\RuleID (for example, rzaher\2hlsdpGmUifjFgxxGIOJw==).
  • On-premises Exchange: MailboxCanonicalName\RuleID (for example, contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==).

You can get these identity values by using the Get-SweepRule cmdlet.

Parameter properties

Type:SweepRuleIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-KeepForDays

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The KeepForDays parameter specifies an action for the Sweep rule that specifies the number of days to keep messages that match the conditions of the rule. After the number of days have passed, the messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder).

You can't use this parameter with the KeepLatest parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-KeepLatest

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The KeepLatest parameter specifies an action for the Sweep rule that specifies the number of messages to keep that match the conditions of the rule. After the number of messages is exceeded, the oldest messages are moved to the location that's specified by the DestinationFolder parameter (by default, the Deleted Items folder).

You can't use this parameter with the KeepForDays parameter, and the Sweep rule must contain a KeepForDays or KeepLatest parameter value.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Mailbox

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The Mailbox parameter specifies the mailbox that contains the rule you want to modify. You can use any value that uniquely identifies the mailbox. For example:

  • Name
  • Alias
  • Distinguished name (DN)
  • Canonical DN
  • Domain\Username
  • Email address
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • User ID or user principal name (UPN)

Parameter properties

Type:MailboxIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Provider

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The Provider parameter specifies the provider for the Sweep rule. If the value contains spaces, enclose the value in quotation marks.

For Sweep rules that you create in Outlook on the web, the default value is Exchange16.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Sender

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The Sender parameter specifies a condition for the Sweep rule that looks for the specified sender in messages. For internal senders, you can use any value that uniquely identifies the sender. For example:

  • Name
  • Alias
  • Distinguished name (DN)
  • Canonical DN
  • Email address
  • GUID

For external senders, use their email address.

Parameter properties

Type:RecipientIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceFolder

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The SourceFolder parameter specifies a condition for the Sweep rule that looks for messages in the specified folder. The syntax is MailboxID:\ParentFolder[\SubFolder].

For the value of MailboxID, you can use any value that uniquely identifies the mailbox. For example:

  • Name
  • Alias
  • Distinguished name (DN)
  • Canonical DN
  • Domain\Username
  • Email address
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • User ID or user principal name (UPN)

Example values for this parameter are john@contoso.com:\Marketing or John:\Inbox\Reports. The default value is MailboxID:\Inbox.

Parameter properties

Type:MailboxFolderIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SystemCategory

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The SystemCategory parameter specifies a condition for the sweep rule that looks for messages with the specified system category. System categories are available to all mailboxes in the organization. Valid values are:

  • NotDefined
  • Bills
  • Document
  • DocumentPlus
  • Event
  • Family
  • File
  • Flight
  • FromContact
  • Important
  • LiveView
  • Lodging
  • MailingList
  • Newsletter
  • Photo
  • Purchase
  • RentalCar
  • RestaurantReservation
  • RetiredPromotion
  • ShippingNotification
  • Shopping
  • SocialUpdate
  • Travel
  • Video

Parameter properties

Type:SystemCategoryType
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.