Method: customers.quarantinedMessages.search

使用特定搜索查询搜索隔离邮件。

HTTP 请求

POST https://mailadminquarantine.googleapis.com/v1/{parent=customers/*}/quarantinedMessages:search

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。拥有此消息集合的父级资源。格式：customers/{customer_id}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
字段
pageSize

integer

可选。需要返回的最大项数。
pageToken

string

可选。从上一个搜索调用返回的 nextPageToken 值。
filter

string

可选。按状态、方向或隔离区过滤结果。过滤条件包含三个可选部分：status、direction 和 quarantine，它们始终使用 AND 逻辑运算符连接。过滤表达式必须遵循 AIP-160 的语法。示例：“status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1”
query

string

可选。采用 Caribou 查询格式的 Gmail 专用搜索查询。

响应正文

[quarantinedMessages.search][] 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
字段
quarantinedMessages[]

object (QuarantinedMessage)

与搜索查询匹配的隔离邮件列表。
nextPageToken

string

用于检索下一页结果的令牌。
unreachable[]

string

服务无法检索其隔离邮件的账号。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/gmail.admin.quarantine
  • https://www.googleapis.com/auth/gmail.admin.quarantine.readonly

如需了解详情，请参阅授权指南。