Rule 元素

项目
02/17/2024

指定应为此上下文邮件加载项评估的激活规则。

加载项类型： 邮件 (上下文)

重要

基于实体的上下文 Outlook 加载项将在 2024 年第 2 季度停用。停用此功能的工作将于 5 月开始，并持续到 6 月底。 6 月之后，上下文加载项将无法再检测邮件项目中的实体以对其执行任务。以下 API 也将停用。

为了帮助最大程度地减少潜在的中断，在基于实体的上下文加载项停用后，仍支持以下内容。

正在开发由联机会议加载项激活的 “加入 会议”按钮的替代实现。结束对基于实体的上下文加载项的支持后，联机会议加载项将自动转换为替代实现，以激活“ 加入会议 ”按钮。
基于实体的上下文加载项停用后，将继续支持正则表达式规则。建议更新上下文加载项，以使用正则表达式规则作为替代解决方案。有关如何实现这些规则的指南，请参阅使用正则表达式激活规则显示 Outlook 加载项。

有关详细信息，请参阅基于实体的上下文 Outlook 加载项的停用。

包含于

属性

属性	必需	说明
xsi:type	是	正在定义的规则类型。

规则类型可以是以下类型之一：

ItemIs
ItemHasAttachment
ItemHasKnownEntity
ItemHasRegularExpressionMatch
RuleCollection

ItemIs 规则

定义一个在选定项为指定类型时计算结果为 true 的规则。

属性

属性	必需	说明
ItemType	是	指定要匹配的项目类型。可以是 `Message` 或 `Appointment`。项目类型包括电子邮件、会议请求、会议响应和会议取消。
FormType	否（在 ExtensionPoint 内），是（在 OfficeApp 内）	指定应用应出现在项目的读取还是编辑表单中。可以是以下值之一：`Read`、`Edit`、`ReadOrEdit`。如果在中`ExtensionPoint`指定`Rule`了，则此值必须为 `Read`。
ItemClass	否	指定要匹配的自定义邮件类别。有关详细信息，请参阅在 Outlook 中为特定邮件类别激活邮件外接程序。
IncludeSubClasses	否	指定当项目是指定邮件类别的子类时，该规则的计算结果是否应为 true；默认值为 `false`。

示例

<Rule xsi:type="ItemIs" ItemType= "Message" />

ItemHasAttachment 规则

定义一个当项目包含附件时计算结果为 true 的规则。

示例

<Rule xsi:type="ItemHasAttachment" />

ItemHasKnownEntity 规则

定义一个当项目主题或正文中包含指定实体类型的文本时计算结果为 true 的规则。

属性

属性	必需	说明
EntityType	是	指定若想规则计算结果为 true 而必须存在的实体类型。可以是以下值之一：`MeetingSuggestion`、`TaskSuggestion`、`Address`、`Url`、`PhoneNumber`、`EmailAddress` 或 `Contact`。
RegExFilter	否	指定一个针对此实体运行以进行激活的正则表达式。
FilterName	否	指定正则表达式筛选器的名称，以便随后能够在你的外接程序代码中引用该名称。
IgnoreCase	否	指定在匹配由 RegExFilter 属性指定的正则表达式时是否忽略大小写。
Highlight	否	注意：这仅适用于 ExtensionPoint> 元素中的<Rule> 元素。< 指定客户端应如何突出显示匹配的实体。可以是以下值之一：`all` 或 `none`。如果未指定，则默认值为 `all`。

示例

<Rule xsi:type="ItemHasKnownEntity" EntityType="EmailAddress" />

ItemHasRegularExpressionMatch 规则

定义一个如果可在项目的指定属性中找到指定的正则表达式的匹配项，则计算结果为 true 的规则。

属性

属性	必需	说明
RegExName	是	指定正则表达式的名称，以便你能够在外接程序的代码中引用该表达式。
RegExValue	是	指定将对其求值的正则表达式以确定是否应显示邮件外接程序。
PropertyName	是	指定正则表达式进行计算所依据的属性名称。可以是以下值之一：`Subject`、`BodyAsPlaintext`、`BodyAsHTML` 或 `SenderSMTPAddress`。如果指定 `BodyAsHTML`，则 Outlook 只会在项目正文为 HTML 时应用正则表达式。否则，Outlook 将不会返回该正则表达式的匹配项。如果指定 `BodyAsPlaintext`，则 Outlook 将始终对项目正文应用正则表达式。重要：如果需要为 <Rule> 元素指定 Highlight 属性，必须将 PropertyName 属性设置为 `BodyAsPlaintext`。
IgnoreCase	否	指定在匹配由 RegExName 属性指定的正则表达式时是否忽略大小写。
Highlight	否	指定客户端应如何突出显示匹配的文本。此属性只能应用于 ExtensionPoint> 元素中的<Rule> 元素。< 可以是以下值之一：`all` 或 `none`。如果未指定，则默认值为 `all`。重要：若要在 Rule> 元素中<指定 Highlight 属性，必须将 PropertyName 属性设置为 `BodyAsPlaintext`。

示例

<Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="SupportArticleNumber" RegExValue="(\W|^)kb\d{6}(\W|$)" PropertyName="BodyAsPlaintext" IgnoreCase="true" Highlight="all" />

RuleCollection

定义一个规则集合以及在计算这些规则时要使用的逻辑运算符。

属性

属性	必需	说明
Mode	是	指定在计算此规则集时要使用的逻辑运算符。可以是 `And` 或 `Or`。

示例

<Rule xsi:type="RuleCollection" Mode="And">
  <Rule xsi:type="ItemIs" ItemType="Message" />
  <Rule xsi:type="ItemHasKnownEntity" EntityType="MeetingSuggestion" />
  <Rule xsi:type="ItemHasKnownEntity" EntityType="Address" Highlight="none" />
</Rule>