Get-InboxRule

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 某些参数和设置可能只属于一个环境或另一个环境。

使用 Get-InboxRule cmdlet 可以查看收件箱规则属性。 可使用收件箱规则来根据指定条件处理“收件箱”中的邮件,并进行将邮件移动到指定文件夹或删除邮件等操作。

有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法

语法

Default (默认值)

Get-InboxRule
    [[-Identity] <InboxRuleIdParameter>]
    [-BypassScopeCheck]
    [-DescriptionTimeFormat <String>]
    [-DescriptionTimeZone <ExTimeZoneValue>]
    [-DomainController <Fqdn>]
    [-IncludeHidden]
    [-Mailbox <MailboxIdParameter>]
    [-ResultSize <Unlimited>]
    [-SkipCount <Int32>]
    [-SweepRules]
    [-UseCustomRouting]
    [<CommonParameters>]

说明

您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果某些参数未包含在分配给你的权限中,则可能无法访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet

注意:此 cmdlet 不适用于Exchange Online中 View-Only 组织管理角色组的成员或Microsoft Entra ID中的全局读取者角色。

示例

示例 1

Get-InboxRule -Mailbox Joe@Contoso.com

此示例检索邮箱 Joe@Contoso.com的所有收件箱规则。

示例 2

Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "MM/dd/yyyy" -DescriptionTimeZone "Pacific Standard Time"

此示例从创建规则时设置了 ReceivedBeforeDate 参数的邮箱 joe@contoso.com 检索收件箱规则 ReceivedLastYear。 本示例使用 DescriptionTimeFormat 和 DescriptionTimeZone 参数来指定规则的 Description 属性中使用的时间和时区的格式设置。

参数

-BypassScopeCheck

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

BypassScopeCheck 开关指定是否为运行命令的用户绕过范围检查。 不必为此开关指定值。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DescriptionTimeFormat

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

DescriptionTimeFormat 参数指定规则说明中时间值的格式。 例如:

MM/dd/yyyyy,其中 MM 是 2 位数的月份,dd 是 2 位数的日期,yyyy 是 4 位数的年份。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DescriptionTimeZone

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

DescriptionTimeZone 参数指定用于规则说明中时间值的时区。

$false:禁用规则或策略。

若要查看可用值,请运行以下命令: $TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display

如果值中有空格,请使用双引号 (") 将此值括起来。 默认值为 Exchange 服务器的时区设置。

参数属性

类型:ExTimeZoneValue
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DomainController

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此参数只在本地 Exchange 中可用。

DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。

参数属性

类型:Fqdn
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Identity

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

Identity 参数指定要查看的收件箱规则。 可以使用唯一标识该规则的任何值。 例如:

  • 名称
  • RuleIdentity 属性 (例如,16752869479666417665) 。
  • Exchange Online: MailboxAlias\RuleIdentity (例如, rzaher\16752869479666417665) 。
  • 本地 Exchange: MailboxCanonicalName\RuleIdentity (例如, contoso.com/Users/Rick Zaher\16752869479666417665) 。

参数属性

类型:InboxRuleIdParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:False
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-IncludeHidden

适用:Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

IncludeHidden 开关指定是否在结果中包含隐藏的收件箱规则。 不必为此开关指定值。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Mailbox

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

Mailbox 参数指定包含收件箱规则的邮箱。 可以使用能够唯一标识邮箱的任意值。 例如:

  • 名称
  • 别名
  • 可分辨名称 (DN)
  • 可分辨名称 (DN)
  • 域\用户名
  • 电子邮件地址
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • 用户 ID 或用户主体名称 (UPN)

参数属性

类型:MailboxIdParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResultSize

适用:Exchange Online、Exchange Online Protection

此参数仅在基于云的服务中可用。

ResultSize 参数指定了要返回的结果的最大数量。 若要返回所有与查询相匹配的请求,则请将此参数的值设为无限制。 默认值为 1000。

参数属性

类型:Unlimited
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SkipCount

适用:Exchange Online

此参数仅在基于云的服务中可用。

{{ Fill SkipCount Description }}

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SweepRules

适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此参数只在本地 Exchange 中可用。

SweepRules 开关指定是否在结果中仅返回扫描规则。 不必为此开关指定值。

扫描规则定期运行,以帮助保持收件箱清洁。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-UseCustomRouting

适用:Exchange Online

此参数仅在基于云的服务中可用。

{{ Fill UseCustomRouting Description }}

参数属性

类型: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

输入

Input types

若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。