Set-SweepRule
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may 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
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 topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not 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 $trueThis example modifies the existing rule that has the rule ID value x2hlsdpGmUifjFgxxGIOJw== with the specified value.
Parameters
-Confirm
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.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DestinationFolder
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.
| Type: | MailboxFolderIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
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.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Enabled
This parameter is reserved for internal Microsoft use.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ExceptIfFlagged
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
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019 |
-ExceptIfPinned
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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Identity
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.
| Type: | SweepRuleIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-KeepForDays
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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-KeepLatest
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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Mailbox
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)
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Name
The Name parameter specifies the name of the Sweep rule. If the value contains spaces, enclose the value in quotation marks.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Provider
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Sender
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.
| Type: | RecipientIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-SourceFolder
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.
| Type: | MailboxFolderIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-SystemCategory
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
| Type: | SystemCategoryType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-WhatIf
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.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |