Set-SweepRule
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 某些参数和设置可能只属于一个环境或另一个环境。
使用 Set-SweepRule cmdlet 修改邮箱中的扫描规则。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
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>]
说明
您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果某些参数未包含在分配给你的权限中,则可能无法访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
示例
示例 1
Set-SweepRule -Identity x2hlsdpGmUifjFgxxGIOJw== -KeepForDays 15 -ExceptIfPinned $true
此示例使用指定值修改具有规则 ID 值 x2hlsdpGmUifjFgxxGIOJw== 的现有规则。
参数
-Confirm
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。
- 破坏性 cmdlet(例如 Remove-* cmdlets)内置有暂停,可强制要求先确认命令,然后再继续操作。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:
-Confirm:$false。 - 其他大多数 cmdlet(例如 New-* 和 Set-* cmdlet)都没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | cf |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DestinationFolder
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
DestinationFolder 参数指定将邮件移动到指定文件夹的扫描规则的作。 语法为 MailboxID:\ParentFolder[\SubFolder]。
对于 的值 MailboxID,可以使用唯一标识邮箱的任何值。 例如:
- 名称
- 别名
- 可分辨名称 (DN)
- 可分辨名称 (DN)
- 域\用户名
- 电子邮件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 用户 ID 或用户主体名称 (UPN)
此参数 john@contoso.com:\Unimportant 的示例值为 或 John:\Inbox\Misc。 默认值为 MailboxID:\Deleted Items。
参数属性
| 类型: | MailboxFolderIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DomainController
适用:2016 Exchange Server、Exchange Server 2019
此参数只在本地 Exchange 中可用。
DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。
参数属性
| 类型: | Fqdn |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Enabled
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
保留此参数以供 Microsoft 内部使用。
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ExceptIfFlagged
适用:2016 Exchange Server、Exchange Server 2019
此参数只在本地 Exchange 中可用。
ExceptIfFlagged 参数为“扫描”规则指定一个例外,该规则查找应用了邮件标志的邮件。 有效值包含:
- $true:规则作不会应用于应用了邮件标志的邮件。
- $false:不使用异常。
典型的消息标志值为:
- 任何
- 呼叫
- DoNotForward
- 随访
- ForYourInformation
- 转发
- NoResponseNecessary
- 阅读
- 答复
- ReplyToAll
- 审阅
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ExceptIfPinned
适用:2016 Exchange Server、Exchange Server 2019
此参数只在本地 Exchange 中可用。
PinMessage 参数指定用于查找固定邮件的扫描规则的异常。 有效值包含:
- $true:规则作不应用于固定到收件箱顶部的邮件。
- $false:不使用异常。
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Identity
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
Identity 参数指定要修改的扫描规则。 可以使用唯一标识该规则的任何值。 例如:
- RuleId 属性 (例如 x2hlsdpGmUifjFgxxGIOJw==) 。
- Exchange Online:
MailboxAlias\RuleID(例如,rzaher\2hlsdpGmUifjFgxxGIOJw==) 。 - 本地 Exchange:
MailboxCanonicalName\RuleID(例如,contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==) 。
可以使用 Get-SweepRule cmdlet 获取这些标识值。
参数属性
| 类型: | SweepRuleIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-KeepForDays
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
KeepForDays 参数指定扫描规则的作,该作指定保留与规则条件匹配的邮件的天数。 经过天数后,邮件将移到 DestinationFolder 参数指定的位置,默认情况下,“已删除邮件”文件夹 () 。
不能将此参数与 KeepLatest 参数一起使用,并且扫描规则必须包含 KeepForDays 或 KeepLatest 参数值。
参数属性
| 类型: | Int32 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-KeepLatest
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
KeepLatest 参数为扫描规则指定一个作,该作指定要保留的与规则条件匹配的邮件数。 超过邮件数后,最早的邮件将移动到 DestinationFolder 参数指定的位置 (,默认情况下,“已删除邮件”文件夹) 。
不能将此参数与 KeepForDays 参数一起使用,并且扫描规则必须包含 KeepForDays 或 KeepLatest 参数值。
参数属性
| 类型: | Int32 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Mailbox
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
Mailbox 参数指定包含要修改的规则的邮箱。 可以使用能够唯一标识邮箱的任意值。 例如:
- 名称
- 别名
- 可分辨名称 (DN)
- 可分辨名称 (DN)
- 域\用户名
- 电子邮件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 用户 ID 或用户主体名称 (UPN)
参数属性
| 类型: | MailboxIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Name
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
Name 参数指定扫描规则的名称。 如果值包含空格,则使用引号括住该值。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Provider
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
Provider 参数指定扫描规则的提供程序。 如果值包含空格,则使用引号括住该值。
对于在 Outlook 网页版 中创建的扫描规则,默认值为 Exchange16。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Sender
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
Sender 参数指定扫描规则的条件,该规则在邮件中查找指定的发件人。 对于内部发件人,可以使用任何能够唯一标识该发件人的值。 例如:
- 名称
- 别名
- 可分辨名称 (DN)
- 可分辨名称 (DN)
- 规范 DN
- GUID
对于外部发件人,请使用其电子邮件地址。
参数属性
| 类型: | RecipientIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SourceFolder
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
SourceFolder 参数指定扫描规则的条件,该规则查找指定文件夹中的邮件。 语法为 MailboxID:\ParentFolder[\SubFolder]。
对于 的值 MailboxID,可以使用唯一标识邮箱的任何值。 例如:
- 名称
- 别名
- 可分辨名称 (DN)
- 可分辨名称 (DN)
- 域\用户名
- 电子邮件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 用户 ID 或用户主体名称 (UPN)
此参数 john@contoso.com:\Marketing 的示例值为 或 John:\Inbox\Reports。 默认值为 MailboxID:\Inbox。
参数属性
| 类型: | MailboxFolderIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SystemCategory
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
SystemCategory 参数指定扫描规则的条件,该规则查找具有指定系统类别的邮件。 系统类别可用于组织中的所有邮箱。 有效值包含:
- 未定义
- 条例 草案
- 文档
- DocumentPlus
- 事件
- 系列
- 文件
- 飞行
- FromContact
- 重要
- LiveView
- 住宿
- MailingList
- 新闻稿
- Photo
- 购买
- RentalCar
- RestaurantReservation
- RetiredPromotion
- ShippingNotification
- 购物
- SocialUpdate
- 旅行
- 视频
参数属性
| 类型: | SystemCategoryType |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-WhatIf
适用:Exchange Server 2016、Exchange Server 2019、Exchange Online
WhatIf 开关模拟命令操作。 可以使用此开关在不实际应用将会发生的更改的情况下预览这些更改。 不必为此开关指定值。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 无线 |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。