Method: customers.quarantinedMessages.get

Позволяет получить метаданные и контент письма, помещенного в карантин.

HTTP-запрос

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

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

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

Параметры
name

string

Обязательно. Название ресурса для помещенного в карантин сообщения, которое нужно получить. Формат: customers/{customer_id}/quarantinedMessages/{quarantined_message_id}

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

Параметры
view

enum (MessageView)

Необязательное поле. Просмотр содержимого сообщения.

Тело запроса

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

Тело ответа

Если ответ получен успешно, его тело содержит экземпляр QuarantinedMessage.

Области авторизации

Требует одной из следующих областей применения OAuth:

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

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

MessageView

Необязательное поле. Представление содержимого сообщения, которое нужно получить.

Перечисления
MESSAGE_VIEW_UNSPECIFIED По умолчанию. Возвращает сообщение с основными метаданными.
MESSAGE_VIEW_BASIC Возвращает только метаданные сообщения.
MESSAGE_VIEW_RAW Возвращает все электронное письмо в виде строки, отформатированной по стандарту RFC 2822 и закодированной по стандарту base64url.
MESSAGE_VIEW_DETAILS Возвращает полную структуру сообщения, включая заголовки, текст и прикрепленные файлы.