Method: customers.quarantinedMessages.list

Запрашивает сообщения, помещенные в карантин, с использованием определенных условий фильтра.

HTTP-запрос

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

URL имеет синтаксис gRPC Transcoding.

Параметры пути

Параметры
parent

string

Обязательно. Родительский ресурс, которому принадлежит эта коллекция сообщений. Формат: customers/{customer_id}

Параметры запроса

Параметры
pageSize

integer

Необязательное поле. Максимальное количество возвращаемых объектов.

pageToken

string

Необязательное поле. Значение nextPageToken, возвращенное из предыдущего запроса List.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Сообщение с ответом для [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

Подробную информацию можно найти в руководстве по авторизации.