要使用 Email Audit API 设置电子邮件监控,管理员需要设置 审核人员接收某个特定用户发送和接收的副本的 以附件形式接收的电子邮件最多允许创建的监控数量和 每天的删除请求数为 1000 个请求。此限制针对每个网域 包含当天任何管理员发出的所有请求。
监控的电子邮件方案包括三种类型的用户:
管理员 — 任何域管理员都可以创建、检索、更新和 使用 Email Audit API 的监控资源删除电子邮件监控。在 此外,管理员可以使用 API 下载邮箱。这些 只能在管理员所对的域内完成 运动控制。
源用户 - 源用户是指接收或发送邮件的用户 监控目标用户正在审核的项目。任何网域 管理员或账号用户可以是源用户。源用户必须 与管理员用户和目标用户属于同一网域。
目标用户 — 目标用户是接收 审核电子邮件。
- 接收所有来信的密件抄送(密送) 和外发电子邮件,包括入站和出站附件, 转发的邮件以及从移动设备发送的电子邮件。
- 网域管理员可以选择启用其他审核 为目标用户提供这些功能。可选功能包括 审核已保存的电子邮件草稿、审核已归档的 Hangouts 聊天内容 向网域内或网域外的其他用户共享访问权限。
- 即使目标用户收到邮件的密送副本, 密送关联不会显示在可访问的邮件标头中 源用户的账号中。
- 每封审核的电子邮件都会以 电子邮件附件。网域管理员可以配置这些 消息要么是完整的电子邮件消息,要么是只有消息 标头。
- 此目标用户必须在 监控的域。此域名必须是与 和源用户
- 目标用户可以是管理员或网域中的用户。 而且,该目标用户可以切换角色,成为源用户 由另一个目标用户审核,该目标用户反过来又会收到 发送给第一位目标用户的所有经过审核的电子邮件。
- 网域管理员会针对一个唯一的 “目标用户 - 源用户”配对。换句话说, 即一个目标用户与一个源用户之间的关系。每次审核 使用 API 监控资源完成如果使用多个 API 监控, 目标用户可以审核网域中的许多用户。此外,使用 多个 API 监控,许多目标用户可以审核一个源用户。
- 如果创建了额外的 API 监控,或现有 API 监控 针对“目标用户 - 源用户”更新监控器 是最后创建的监视器,它将取代任何现有监视器。 基本上,这就是更新 API 监控的方法。更多信息 有关如何更新监控工具的信息,请参阅 更新电子邮件监控。
创建电子邮件监控
要创建电子邮件监控,请随电子邮件发送以下 POST
请求
监控资源:
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
替换以下内容:
DOMAIN_NAME
:Google Workspace 域名,用于 example.comSOURCE_USERNAME
:您想要使用的用户名 监控指标。
POST
请求包含以下 Content-type
标头:
Content-type: application/atom+xml
有关要在电子邮件监控请求中使用的参数的完整列表,请参阅
资源:monitor
。
创建新监控的示例
该示例使用以下参数:
- 要审核的用户是
amal@example.com
。 destUserName
为“izumi
”。beginDate
为“June 15, 2022, 00:00 hours
”。endDate
为“June 30, 2022, 23:20 hours
”。incomingEmailMonitorLevel
为“FULL_MESSAGE
”。outgoingEmailMonitorLevel
为“HEADER_ONLY
”。draftMonitorLevel
为“FULL_MESSAGE
”。chatMonitorLevel
为“FULL_MESSAGE
”。
协议
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal <atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'> <apps:property name='destUserName' value='izumi'/> <apps:property name='beginDate' value='2022-06-15 00:00'/> <apps:property name='endDate' value='2022-06-30 23:20'/> <apps:property name='incomingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='outgoingEmailMonitorLevel' value='HEADER_ONLY'/> <apps:property name='draftMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='chatMonitorLevel' value='FULL_MESSAGE'/> </atom:entry>
如果成功,服务器将返回 201 CREATED
状态代码以及
包含显示新监控的 entry
元素的 AtomPub 条目
设置:
<entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'> <id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/id</id> <updated>2022-04-17T15:02:45.646Z</updated/> <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/id'/> <link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/id'/> <apps:property name='destUserName' value='izumi'/> <apps:property name='beginDate' value='2022-06-15 00:00'/> <apps:property name='endDate' value='2022-06-30 23:20'/> <apps:property name='incomingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='outgoingEmailMonitorLevel' value='HEADER_ONLY'/> <apps:property name='draftMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='chatMonitorLevel' value='FULL_MESSAGE'/> </entry>
Java
import java.util.Calendar; import com.google.gdata.client.appsforyourdomain.audit.AuditService; import com.google.gdata.data.appsforyourdomain.generic.GenericEntry; import com.google.gdata.client.appsforyourdomain.audit.MailMonitor; ... MailMonitor monitor = new MailMonitor(); Calendar beginDate = Calendar.getInstance(); beginDate.set(2022, Calendar.JUNE, 15, 0, 0) monitor.setBeginDate(beginDate.getTime()); Calendar endDate = Calendar.getInstance(); endDate.set(2022, Calendar.JUNE, 30, 23, 20); monitor.setEndDate(endDate.getTime()); monitor.setIncomingEmailMonitorLevel("FULL_MESSAGE"); monitor.setOutgoingEmailMonitorLevel("HEADER_ONLY"); monitor.setDraftMonitorLevel("FULL_MESSAGE"); monitor.setChatMonitorLevel("FULL_MESSAGE"); monitor.setDestUserName("izumi"); AuditService service = new AuditService("admin@example.com", "p@55w0rd", "example.com", "example.com-auditapp-v1"); GenericEntry entry = service.createMailMonitor("amal", monitor);
.NET
using System; using Google.GData.Apps; using Google.GData.Extensions.Apps; ... MailMonitor monitor = new MailMonitor(); monitor.BeginDate = new DateTime(2022, 6, 15); monitor.EndDate = new DateTime(2022, 6, 30, 23, 20, 0); monitor.IncomingEmailMonitorLevel = MonitorLevel.FULL_MESSAGE; monitor.OutgoingEmailMonitorLevel = MonitorLevel.HEADER_ONLY; monitor.DraftMonitorLevel = MonitorLevel.FULL_MESSAGE; monitor.ChatMonitorLevel = MonitorLevel.FULL_MESSAGE; monitor.DestinationUserName = "izumi"; AuditService service = new AuditService("example.com", "example.com-auditapp-v1"); service.setUserCredentials("admin@example.com", "p@55w0rd"); MailMonitor monitorEntry = service.CreateMailMonitor("amal", monitor);
更新电子邮件监控
更新源用户和目标用户相同的监控时, 初始监控的属性设置会替换为新设置。
要更新电子邮件监控中的审核配置,请向以下地址发送 POST
请求:
监控 Feed 的 URI,并添加 Authorization
标头:
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
替换以下内容:
DOMAIN_NAME
:Google Workspace 域名,用于 example.comSOURCE_USERNAME
:电子邮件监控的用户名 要更新的项目
更新电子邮件监控的示例
本示例将更新在
创建电子邮件监控的示例
方法是更新必需属性 endDate
和可选属性
chatMonitorLevel
。此示例使用以下参数:
- 新的
endDate
为August 30, 2022, 23:20 hours
。 chatMonitorLevel
现为HEADER_ONLY
。- 要审核的用户仍为
amal@example.com
。 destUserName
仍为izumi
。
未更新的监控属性会还原为其默认值。对于
在本示例中,incomingEmailMonitorLevel
和
outgoingEmailMonitorLevel
属性还原为 FULL_MESSAGE
,并且
draftMonitorLevel
将还原为 NONE
。
协议
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal <atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'> <apps:property name='destUserName' value='izumi'/> <apps:property name='endDate' value='2022-08-30 23:20'/> <apps:property name='chatMonitorLevel' value='HEADER_ONLY'/> </atom:entry>
如果成功,服务器将返回 201 CREATED
状态代码以及
具有更新的 entry
元素的 AtomPub 条目。属性
未更新且在响应中显示的这些会还原为默认值。
<entry> <entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'> <id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi</id> <updated>2022-08-20T00:28:57.319Z</updated> <link rel='self' type='application/atom+xml' href="https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi" /> <link rel='edit' type='application/atom+xml' href="https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi" /> <apps:property name='chatMonitorLevel' value='HEADER_ONLY' /> <apps:property name='destUserName' value='izumi' /> <apps:property name='endDate' value='2022-08-30 23:20' /> </entry>
Java
import java.util.Calendar; import com.google.gdata.client.appsforyourdomain.audit.AuditService; import com.google.gdata.client.appsforyourdomain.audit.MailMonitor; import com.google.gdata.data.appsforyourdomain.generic.GenericEntry; ... MailMonitor monitor = new MailMonitor(); Calendar endDate = Calendar.getInstance(); endDate.set(2022, Calendar.AUGUST, 30, 23, 20); monitor.setEndDate(endDate.getTime()); monitor.setChatMonitorLevel("HEADER_ONLY"); monitor.setDestUserName("izumi"); AuditService service = new AuditService("admin@example.com", "p@55w0rd", "example.com", "example.com-auditapp-v1"); GenericEntry entry = service.createMailMonitor("amal", monitor);
.NET
using System; using Google.GData.Apps; using Google.GData.Extensions.Apps; ... MailMonitor monitor = new MailMonitor(); monitor.EndDate = new DateTime(2022, 8, 30, 23, 20, 0); monitor.ChatMonitorLevel = MonitorLevel.HEADER_ONLY; monitor.DestinationUserName = "izumi"; AuditService service = new AuditService("example.com", "example.com-auditapp-v1"); service.setUserCredentials("admin@example.com", "p@55w0rd"); MailMonitor monitorEntry = service.CreateMailMonitor("amal", monitor);
检索源用户的所有电子邮件监控
如需检索与源用户关联的所有监控,请创建 HTTP GET
请求监控 Feed URI(使用日期的世界协调时间 (UTC) 格式),并在
Authorization
标头:
GET https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
替换以下内容:
DOMAIN_NAME
:Google Workspace 域名,用于 example.comSOURCE_USERNAME
:电子邮件监控的用户名 您要检索的数据。
此操作在请求正文中没有任何参数,因此 XML 正文为空。
检索所有电子邮件监控的示例
以下示例检索为用户 amal@example.com
创建的所有监控:
协议
GET https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal
如果成功,服务器将返回 201 CREATED
状态代码以及
包含 entry
元素的两台显示器的 AtomPub 供稿,
两个目标用户 (izumi@example.com,
taylor@example.com
) 的设置。
<feed xmlns:atom='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:apps='http://schemas.google.com/apps/2006'> <id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal</id> <updated>2010-03-17T15:29:21.064Z</updated> <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal'/> <link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal'/> <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal'/> <openSearch:startIndex>1</openSearch:startIndex> <entry> <id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi</id> <updated>2022-04-17T15:29:21.064Z</updated> <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi&'/> <link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/feeds/compliance/audit/mail/monitor/example.com/amal/izumi&'/> <apps:property name='requestId' value='53156'/> <apps:property name='destUserName' value='izumi'/> <apps:property name='beginDate' value='2022-06-15 00:00'/> <apps:property name='endDate' value='2022-06-30 23:20'/> <apps:property name='incomingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='outgoingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='draftMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='chatMonitorLevel' value='FULL_MESSAGE'/> </entry> <entry> <id>>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/taylor</id> <updated>2022-05-17T15:29:21.064Z</updated> <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/taylor'/> <link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/taylor'/> <apps:property name='requestId' value='22405'/> <apps:property name='destUserName' value='taylor'/> <apps:property name='beginDate' value='2022-06-20 00:00'/> <apps:property name='endDate' value='2022-07-30 23:20'/> <apps:property name='incomingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='outgoingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='draftMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='chatMonitorLevel' value='FULL_MESSAGE'/> </entry> </feed>
Java
import com.google.gdata.client.appsforyourdomain.audit.AuditService; import com.google.gdata.data.appsforyourdomain.generic.GenericFeed; ... AuditService service = new AuditService("admin@example.com", "p@55w0rd", "example.com", "example.com-auditapp-v1"); GenericFeed feed = service.retrieveMonitors("amal");
.NET
using System; using System.Collections.Generic; using Google.GData.Apps; using Google.GData.Extensions.Apps; ... AuditService service = new AuditService("example.com", "example.com-auditapp-v1"); service.setUserCredentials("admin@example.com", "p@55w0rd"); GenericFeed<MailMonitor> monitors = service.RetrieveMailMonitors("amal");
删除电子邮件监控
要删除电子邮件监控,请将 HTTP DELETE
请求发送到监控供稿的
删除 URI 并添加 Authorization
标头:
DELETE https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME/DESTINATION_USERNAME
替换以下内容:
DOMAIN_NAME
:Google Workspace 域名,用于 example.comSOURCE_USERNAME
:电子邮件监控的用户名 删除的数据DESTINATION_USERNAME
:接收 审核电子邮件。
删除电子邮件监控的示例
此示例会删除为用户 amal@example.com
创建的监控
其中 destinationUserName
为 izumi
。
协议
DELETE https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi
Java
import com.google.gdata.client.appsforyourdomain.audit.AuditService; ... AuditService service = new AuditService("admin@example.com", "p@55w0rd", "example.com", "example.com-auditapp-v1"); service.deleteMonitor("amal", "izumi");
.NET
using System; using Google.GData.Apps; using Google.GData.Extensions.Apps; ... AuditService service = new AuditService("example.com", "example.com-auditapp-v1"); service.setUserCredentials("admin@example.com", "p@55w0rd"); service.DeleteMailMonitor("amal", "izumi");