MailFilterList 报告
MailFilterList REST URI 提供了其他 Office 365 报告中可用的字符串值。项目根据 SelectTarget 值进行分组。每个组中的值用于 $filter 查询选项中。
上次修改时间: 2015年9月17日
适用范围: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailFilterList[?ODATA options]
字段
可在 $select、$filter 和 $orderby ODATA2 查询选项中指定下列字段。如果没有提供 $select 选项,将返回所有字段。
名称 |
WCF 类型* |
EDM 类型* |
[In/Out]** 说明 |
示例值 |
在其中添加的服务版本 |
---|---|---|---|---|---|
Display |
string |
未指定 |
[In/Out] 可以用来显示用于其他报告的所选内容的 Value 字段的版本。 |
RedirectMessage 或 RemoveMessageHeader |
2013-V1 |
Domain |
string |
未指定 |
[In/Out] 完全限定的域名 (FQDN)。 |
example.onmicrosoft.com |
2013-V1 |
Organization |
string |
未指定 |
[In/Out] Office 365 组织标识符,以 FQDN 的形式表示。 |
example.onmicrosoft.com |
2013-V1 |
ParentTarget |
string |
未指定 |
[In/Out] 此条目所属的项目类型。与 ParentValue 字段结合使用,将在条目中创建类别/子类别关系。此字段的值与 SelectionTarget 值相匹配,以指定父类型。截止 2013 年 2 月,将仅显示 DlpPolicy 这一个值。 |
DlpPolicy |
2013-V1 |
ParentValue |
string |
未指定 |
[In/Out] 父类别的名称,此条目是父类别的子类别。 |
OrgDlpPolicyName |
2013-V1 |
SelectionTarget |
string |
未指定 |
[In/Out] 包含条目的类别。SelectionTarget 的值与其他报告中的字段名称对应。 |
Actions、EventTypes |
2013-V1 |
Value |
string |
未指定 |
[In/Out] 条目的值,用作其他报告的比较字符串。 |
example.onmicrosoft.com |
2013-V1 |
*WCF 类型指在 Visual Studio 中创建 Windows Communications Framework (WCF) 服务参考时分配给字段的 .NET Framework 数据类型。EDM 类型指 ATOM 格式化报告中返回的 ADO.NET 实体数据模型 (EDM) 类型。
**[In/Out]:请参阅"输入参数和报告输出列"部分。
备注
报告中的每个条目都包括元数据的多个字段。有关详细信息,请参阅 Office 365 报告 Web 服务返回的常见元数据。
如果您基于此报告返回的值构建用户界面,请在用户界面中使用 Display 字段,在这些报告的 $filter 查询选项中使用 Value 字段。您的应用程序不应假设 Display 和 Value 始终相同。
SelectionTarget 类别
MailFilterList 报告提供了用于创建其他报告的 $filter 查询选项的字符串。对于这些报告,您可以指定系统将通过指定值与报告字段相匹配返回哪些条目。例如,在 MailDetailMailware 报告中,您可以指定报告仅使用 $filter=Action eq ‘Quarantine’ 返回将邮件发送到隔离邮箱的条目。应从 MailFilterList 返回的可能的 ActionsValues 列表中选择 Quarantine 值,以确保正确匹配。下表列出了其他报告中的 SelectionTarget 值及其相应字段定义的类别。与每个 SelectionTarget 类别关联的值的列表可因域、订阅和配置而异。例如,返回的 DlpPolicy 值将包括由管理员创建的策略。
SelectionTarget |
相应的字段名称、报告名称和含义 |
---|---|
Actions |
MailDetailDlpPolicy、MailDetailMalware、MailDetailSpam、MailDetailTransportRule、MailTrafficPolicy、MailTraffic 和 MessageTraceDetail 报告中的 Action 字段。指定在系统处理邮件时对邮件执行的操作。此列表可由管理员通过配置更改进行扩展。 |
DlpPolicy |
MailDetailDlpPolicy 和 MailTrafficPolicy 报告中的 DlpPolicy 字段。数据丢失防护 (DLP) 策略包含一个或多个 DLP 规则。 |
DlpRule |
MailDetailDlpPolicy、MailTrafficPolicy 和 MailTrafficSummary 报告中的 TransportRule 字段。每个 DlpRule 条目将具有DlpPolicy 的一个 ParentTarget 字段值,并且其 ParentValue 字段将设置为 DlpPolicy 类别中的条目名称。 |
Domain |
MailDetailDlpPolicy、MailDetailMalware、DailDetailSpam、MailDetailTransportRule、MailTrafficPolicy、MailTraffic、MailTrafficSummary 和 MailTrafficTop 报告中的 Domain 字段。这些条目指定分配给组织的 FQDN。 |
EventTypes |
MailDetailDlpPolicy、MailDetailMalware、MailDetailSpam、MailDetailTransportRule、MailTrafficPolicy、MailTraffic 和 MailTrafficTop 报告中的 EventType 字段。也是 MessageTraceDetail 报告中的 Event 字段。这些条目指定邮件处理过程中执行的操作。 |
TransportRule |
MailDetailDlpPolicy、MailDetailTransportRule、MailTrafficPolicy 和 MailTrafficSummary 报告中的 TransportRule 字段。 |
以下部分提供了有关指示了 SelectionTarget 值的 MailFilterList 报告条目的详细信息。
SelectionTarget eq ’Actions’ 值
使 $filter=SelectionTarget eq ’Actions’ 指示对垃圾邮件进行哪种自动或管理操作的 MailFilterList 条目。如果尚未执行任何操作,则字段将为 null。下表列出了其他可用的操作。请记住,这些操作通常需要一些管理配置。例如,如果垃圾邮件指示添加了密件抄送收件人,则 Office 365 管理员必须已配置该地址和其他设置。您的应用程序可通过使用 $filter=SelectionTarget eq 'Actions' 查询选项获取 MailFilterList 报告的方式获取这些操作的列表。有关详细信息,请参阅 MailFilterList 报告主题。
Action 值 |
说明 |
---|---|
AddBccRecipient |
密件抄送 (BCC) 收件人已添加到邮件中。 |
AddCcRecipient |
抄送 (CC) 收件人已添加到邮件中。 |
AddManagerAsRecipient |
如果发件人或收件人均在组织中,并且已在配置文件中指定了经理,那么其经理将作为收件人行的收件人进行添加。这是分别针对原始发件人和收件人进行的操作,以便添加两个经理。 |
AddToRecipient |
收件人已添加到收件人行。 |
ApplyClassification |
邮件分类已更改。 |
ApplyHtmlDisclaimer |
免责声明邮件已添加到邮件末尾处。此免责声明为 HTML 格式。 |
DeleteMessage |
邮件已删除。 |
GenerateIncidentReport |
已生成事件报告并已发送给电子邮件管理员。 |
ModerateMessageByManager |
已要求发件人的经理批准正在发送的邮件。 |
ModerateMessageByUser |
已要求特定用户批准正在发送的邮件。此指定的用户通常为电子邮件管理员。 |
NotifySender |
已将一封单独的邮件发送至发件人,指示其邮件被标识为垃圾邮件。 |
PrependSubject |
已将主题行修改为带有前缀,指示邮件可能为垃圾邮件。例如:"SUSPECT:" |
Quarantine |
邮件已移动到隔离邮箱中。 |
RedirectMessage |
已删除原始收件人、抄送和密件抄送收件人,并已将邮件发送至另一个收件人。 |
RejectMessage |
通知传输邮件的邮件系统,邮件已被 Office 365 拒绝。 |
RemoveMessageHeader |
从邮件中删除了邮件头。电子邮件管理员配置要删除的标头。 |
RequireTLS |
电子邮件系统会将邮件传输到接收系统,并要求该系统接收由 TLS 加密(而非作为纯文本)的邮件。 |
RightsProtectMessage |
传输时,配置的数字版权管理 (DRM) 设置将应用于邮件中。 |
RouteMessageUsingConnector |
将通过已配置的邮件连接器传输此邮件。 |
SetAuditSeverityLow、SetAuditSeverityMedium、SetAuditSeverityHigh |
该邮件已传输,并已对邮件设置审核严重性。 |
SetMessageHeader |
已设置配置的标头。 |
SetSpamConfidenceLevel |
垃圾邮件信任级别 (SCL) 标头已添加到邮件中。 |
StopRuleProcessing |
指示已对邮件应用"停止处理垃圾邮件"处理规则。 |
SelectionTarget eq ’DlpPolicy’ 值
具有 $filter=SelectionTarget eq ’DlpPolicy’ 的条目的 Display 和 Value 字段在配置 Office 365 数据丢失防护 (DLP) 策略时已由管理员设置。管理员定义在通过电子邮件系统处理邮件时应用的已命名策略。DLP 策略是 DLP 规则的容器。策略和规则之间的类别/子类别关系在本节结尾处进行了说明。DlpPolicy 值的列表最终由管理员控制。策略 Display 值的示例为:Company Sensitive Data、Financial Data Detection 和 HIPAA Detection。
SelectionTarget eq ’DlpRule’ 值
使用$filter=SelectionTarget eq ’DlpRule’ 的条目的 Display 和 Value 字段在配置 Office 365 DLP 策略规则时已由管理员配置。邮件通过电子邮件系统进行处理时,DLP 规则检测邮件中的某些条件,并在响应中执行某些操作。MailFilterList 报告结果中的 DlpRule 条目尝试通过 ParentTarget 和 ParentValue 字段值包含 DlpPolicy 条目。策略和规则之间的类别/子类别关系在本节结尾处进行了说明。DlpRule 值的列表最终由管理员控制。规则 Display 值的示例为:PII Detection、PCI DSS Detection Rule 1 和 Financial Data Detection Rule 1。
SelectionTarget eq ’Domain’ 值
使用 $filter=SelectionTarget eq ’Domain’ 的条目的 Display 和 Value 字段指示与组织关联的域名。Office 365 支持使用多权威和关联域的组织,并且报告 Web 服务 可以根据包括 Domain 字段的报告的域筛选报告数据。
SelectionTarget eq ’EventTypes’ 值
具有 $filter=SelectionTarget eq ’EventType’ 的 MailFilterList 条目指示对邮件进行哪种类型的扫描。下表列出了其他可用的事件类型。请记住,这些事件可能需要一些管理配置,并且可因组织的订阅选项而异。您的应用程序可以使用 $filter=SelectionTarget eq 'EventTypes' 查询选项获取 MailFilterList 报告,从而获取这些事件类型的列表。有关详细信息,请参阅 MailFilterList 报告主题。
EventTypes 值 |
说明 |
---|---|
DLPActionHits |
此邮件触发了 DLP 规则的执行。 |
DLPMessages |
正在扫描邮件以确定是否由 DLP 规则生成。 |
DLPPolicyFalsePositive |
已检查邮件以确定是否已正确触发以前检测到的 DLP 策略违反行为。 |
DLPPolicyHits |
已检查邮件以确定是否触发了 DLP 策略的所有规则。 |
DLPPolicyOverride |
邮件上的信息表明已针对邮件覆盖了一个或多个 DLP 策略。 |
DLPRuleHits |
已检查邮件以确定是否触发了 DLP 规则。 |
GoodMail |
正在扫描来自已知良好发件人的邮件。 |
Malware |
正在扫描邮件中的恶意软件。例如,病毒、勒索软件等。 |
SpamContentFiltered |
正在扫描指示为垃圾邮件的邮件,如主动提供的商业电子邮件或网络钓鱼邮件。 |
SpamEnvelopeBlock |
正在扫描指示为包含垃圾邮件的邮件信封。 |
SpamIPBlock |
正在检查邮件,以查看是否来自已知中继或产生垃圾邮件的 IP 地址。 |
TopMailUser |
正在收集邮件收件人和发件人,因此他们的邮件计数器可能要更新,以供 MailTrafficTop 报告使用。 |
TopMalware |
标识为恶意软件的邮件针对 MailTrafficTop 报告计算。 |
TopMalwareUser |
标识为包含恶意软件的邮件针对收件人和发件人计算,以用于 MailTrafficTop 报告。 |
TopSpamUser |
标识为垃圾邮件的邮件针对收件人和发件人计算,以用于 MailTrafficTop 报告。 |
TransportRuleActions |
已检查邮件传输历史记录,以收集有关用于处理邮件的传输规则的信息,以用于 MailTrafficTop 报告。 |
TransportRuleHits |
已检查邮件传输历史记录,以收集有关已触发传输规则的信息,以用于 MailTrafficTop 报告。 |
TransportRuleMessages |
正在扫描邮件以确定是否由传输规则创建。 |
SelectionTarget eq ’TransportRule’ 值
使用 $filter=SelectionTarget eq ’TransportRule’ 的条目的 Display 和 Value 字段在配置 Office 365 策略规则时已由管理员配置。邮件通过电子邮件系统进行处理时,DLP 规则检测邮件中的某些条件,并在响应中执行某些操作。MailFilterList 报告结果中的 DlpRule 条目尝试通过 ParentTarget 和 ParentValue 字段值包含 DlpPolicy 条目。策略和规则之间的类别/子类别关系在本节结尾处进行了说明。DlpRule 值的列表最终由管理员控制。规则 Display 值的示例为:PII Detection、PCI DSS Detection Rule 1 和 Financial Data Detection Rule 1。
了解 ParentTarget 和 ParentValue 字段
DLP 相关的条目构成 MailFilterList 条目(其中 SelectionTarget 为 DlpPolicy 或 DlpRule)中的类别/子类别关系。下图描述了由两个策略和四个规则组成的示例关系。策略一使用规则-A 和规则-B,策略二使用规则-C、规则-B 和规则-D。由于两个不同的策略都包括规则-B,因此 MailFilterList 结果包括规则-B 的两个条目,由各自的 ParentValue 字段值(分别与相应的 DlpPolicyValue 字段匹配)进行区分。
图 1. 两个策略和四个规则的图表
示例
以下请求和响应对演示如何检索邮件筛选 Actions 的 MailFilterList 报告。为清楚起见,请求中添加了换行符,并从结果中删除了一些 Atom XML 结果。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailFilterList?
$select=Display,Domain,Organization,ParentTarget,ParentValue,SelectionTarget&
$filter=SelectionTarget%20eq%20'Actions'&
$format=Atom
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/"
xmlns="http://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices"
xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailFilterList</id>
<title type="text">MailFilterList</title>
<updated>2013-02-08T02:32:05Z</updated>
<link rel="self" title="MailFilterList" href="MailFilterList" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailFilterList('Actions')</id>
<category term="TenantReporting.MailFilterListReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailFilterListReport" href="MailFilterList('Actions')" />
<title />
<updated>2013-02-08T02:32:05Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Organization>example.onmicrosoft.com</d:Organization>
<d:SelectionTarget>Actions</d:SelectionTarget>
<d:Display>AddBccRecipient</d:Display>
<d:ParentTarget m:null="true" />
<d:ParentValue m:null="true" />
<d:Domain m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailFilterList('Actions')</id>
<category term="TenantReporting.MailFilterListReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailFilterListReport" href="MailFilterList('Actions')" />
<title />
<updated>2013-02-08T02:32:05Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Organization>example.onmicrosoft.com</d:Organization>
<d:SelectionTarget>Actions</d:SelectionTarget>
<d:Display>AddCcRecipient</d:Display>
<d:ParentTarget m:null="true" />
<d:ParentValue m:null="true" />
<d:Domain m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailFilterList('Actions')</id>
<category term="TenantReporting.MailFilterListReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailFilterListReport" href="MailFilterList('Actions')" />
<title />
<updated>2013-02-08T02:32:05Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Organization>example.onmicrosoft.com</d:Organization>
<d:SelectionTarget>Actions</d:SelectionTarget>
<d:Display>AddManagerAsRecipient</d:Display>
<d:ParentTarget m:null="true" />
<d:ParentValue m:null="true" />
<d:Domain m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailFilterList('Actions')</id>
<category term="TenantReporting.MailFilterListReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailFilterListReport" href="MailFilterList('Actions')" />
<title />
<updated>2013-02-08T02:32:05Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Organization>example.onmicrosoft.com</d:Organization>
<d:SelectionTarget>Actions</d:SelectionTarget>
<d:Display>AddToRecipient</d:Display>
<d:ParentTarget m:null="true" />
<d:ParentValue m:null="true" />
<d:Domain m:null="true" />
</m:properties>
</content>
</entry>
[[ lines removed for clarity ]]
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailFilterList('Actions')</id>
<category term="TenantReporting.MailFilterListReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailFilterListReport" href="MailFilterList('Actions')" />
<title />
<updated>2013-02-08T02:32:05Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Organization>example.onmicrosoft.com</d:Organization>
<d:SelectionTarget>Actions</d:SelectionTarget>
<d:Display>SetSpamConfidenceLevel</d:Display>
<d:ParentTarget m:null="true" />
<d:ParentValue m:null="true" />
<d:Domain m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailFilterList('Actions')</id>
<category term="TenantReporting.MailFilterListReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailFilterListReport" href="MailFilterList('Actions')" />
<title />
<updated>2013-02-08T02:32:05Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Organization>example.onmicrosoft.com</d:Organization>
<d:SelectionTarget>Actions</d:SelectionTarget>
<d:Display>StopRuleProcessing</d:Display>
<d:ParentTarget m:null="true" />
<d:ParentValue m:null="true" />
<d:Domain m:null="true" />
</m:properties>
</content>
</entry>
</feed>
以下 MailFilterList 报告请求和响应检索与 Office 365 组织关联的所有域的 Display 字段,为 JSON 格式。为清楚起见,请求中添加了换行符。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailFilterList?
$select=Display&
$filter=SelectionTarget%20eq%20'Domain'&
$format=Json
{
"d":
{
"results":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailFilterList('Domain')",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailFilterList('Domain')",
"type":"TenantReporting.MailFilterListReport"
},
"Display":"example.onmicrosoft.com"
}
]
}
}
输入参数和报告输出列
字段表格中的 [In/Out] 指示符具有以下含义:
字段表中标记为 [In] 的字段主要在 $filter=、$orderby= 和其他限制报告应返回哪些条目的查询选项中使用。字段表中标记为 [In] 的字段可包含在 $select= 选项中,它们将在报告条目中出现,但不包含有用数据。
字段表中标记为 [In/Out] 的字段可在列选择 ($select=) 和条目限制($filter= 和 $orderby=)选项中使用。当您在 $select= 选项中包含这些字段之一时,它们将在报告条目中出现,且将在提供时包含有用数据。
兼容性
MailFilterList 报告在 Office 365 服务版本 2013-V1中引入。有关版本控制的详细信息,请参阅 Office 365 报告 Web 服务中的版本控制。
相应的 PowerShell cmdlet
MailFilterList 报告将返回与 Get-MailFilterListReport Windows PowerShell cmdlet 相同的信息。
权限
您用于访问报告的帐户必须拥有该 Office 365 组织的管理权限。如果此帐户可以在 Office 365 控制面板中查看此报告,则此帐户具有从 REST Web 服务检索数据的权限。此报告要求为用户分配收件人(仅查看)角色。在默认的 Office 365 权限结构中,具有下列管理员权限的用户可以访问此报告:帐务管理员 、全局管理员、密码管理员、服务管理员和用户管理管理员。
数据粒度、 持久性和可用性
此报告的信息不是基于时间的。此报告返回的部分数据取决于管理员配置 Office 365 服务的方式。只要订阅不过期,都可以使用此报告。