Method: customers.quarantinedMessages.list

使用特定过滤条件查询隔离的邮件。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

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

查询参数

参数
pageSize

integer

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

pageToken

string

可选。从上一个 List 请求返回的 nextPageToken 值。

请求正文

请求正文必须为空。

响应正文

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

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

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

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