Get-InboxRule

  • 参考
模块:
ExchangePowerShell
适用于:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

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

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

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

语法

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

说明

您必须先获得权限，然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数，但如果这些参数并未包含在分配给您的权限中，那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限，请参阅 Find the permissions required to run any Exchange cmdlet。

注意：此 cmdlet 不适用于 Exchange Online 中View-Only组织管理角色组的成员或 Azure Active Directory 中的全局读取者角色。

示例

示例 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

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

Type:SwitchParameter
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

-DescriptionTimeFormat

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

mm/dd/yyyy，其中 mm 为 2 位月份，dd 为 2 位日期，yyyy 为 4 位年份。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-DescriptionTimeZone

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 服务器的时区设置。

Type:ExTimeZoneValue
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-DomainController

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

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

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

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

  • 名称
  • RuleIdentity 属性 (例如，16752869479666417665) 。
  • Exchange Online： MailboxAlias\RuleIdentity (例如， rzaher\16752869479666417665) 。
  • 本地 Exchange： MailboxCanonicalName\RuleIdentity (例如， contoso.com/Users/Rick Zaher\16752869479666417665) 。
Type:InboxRuleIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-IncludeHidden

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Mailbox

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

  • 名称
  • 别名
  • 可分辨名称 (DN)
  • 可分辨名称 (DN)
  • 域\用户名
  • 电子邮件地址
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • 用户 ID 或用户主体名称 (UPN)
Type:MailboxIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-SweepRules

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

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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

输入

Input types

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

输出

Output types

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