Mail Admin Quarantine API 概览

借助 Mail Admin Quarantine API，Google Workspace 管理员可以通过编程方式管理 Gmail 保留在管理员隔离区中的电子邮件。如果邮件符合您在 Google 管理控制台中配置的合规性、数据泄露防护 (DLP) 或安全规则，则会进入隔离区。

使用该 API 构建安全和合规自动化功能，例如：

  • 将隔离的邮件检索到 SIEM 或 SOAR 平台进行分类。
  • 在决定如何处理邮件之前，先查看邮件标头、正文摘要和附件。
  • 逐一或批量（最多 500 封邮件）释放安全的邮件并拒绝不安全的邮件。

重要资源

Admin Quarantine API 会在客户下公开以下资源：

资源 资源名称 说明
客户 customers/CUSTOMER_ID 您的 Google Workspace 账号。如需了解详情，请参阅查找客户 ID。
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID 隔离区中保留的电子邮件。MESSAGE_OWNER 是邮箱所有者的邮箱，MESSAGE_ID 是不可变的 Gmail 邮件 ID。
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID 您在管理控制台中配置的隔离区。
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID 跟踪批量释放或批量拒绝请求的长时间运行的操作。

QuarantinedMessage 包含以下 State 对象之一：

州 说明
PENDING_TRIAGE 邮件被保留在隔离区中，等待管理员做出决定。
RELEASED 管理员释放了邮件，Gmail 已将其递送。
DENIED 管理员拒绝了该邮件，Gmail 舍弃了该邮件。

方法

所有请求都定位到 https://mailadminquarantine.googleapis.com/v1。

方法 HTTP 请求 说明
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages 列出过去 30 天内被隔离的邮件。
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search 使用过滤器或 Gmail 搜索查询来搜索隔离的邮件。
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* 获取元数据、解析后的内容或原始 RFC 2822 邮件。
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release 释放单封邮件以进行递送。
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny 拒绝单条消息。
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease 异步释放最多 500 条消息。
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny 异步拒绝最多 500 条消息。
customers.operations.get GET /customers/*/operations/* 获取批量操作的状态和结果。
customers.quarantines.list GET /customers/*/quarantines 列出为客户配置的隔离区。
customers.quarantines.get GET /customers/*/quarantines/* 获取隔离区的显示名称和说明。

简要实现步骤

  1. 设置 API：加入开发者预览版计划，在 Google Cloud 项目中启用该 API，找到您的客户 ID，并授予所需的管理员权限。
  2. 使用全网域授权进行授权：创建服务账号，使用 Admin Quarantine API 范围配置全网域授权，并获取模拟管理员的访问令牌。
  3. 分类整理消息：
    1. 列出和搜索被隔离的邮件。
    2. 获取消息详情。
    3. 释放或拒绝邮件，或批量释放或拒绝邮件。
  4. 确保不超出用量配额。

审核日志记录

每个读取或更改隔离邮件的 API 调用都会记录在管理控制台审核和调查日志中，并归因于运行请求的管理员。

后续步骤