REST Resource: customers.quarantinedMessages

Ресурс: QuarantinedMessage

Ресурс QuarantinedMessage представляет собой электронное письмо, помещенное в административный карантин.

JSON-представление 
{
  "name": string,
  "messageId": string,
  "messageOwner": string,
  "quarantines": [
    string
  ],
  "receiveTime": string,
  "direction": enum (Direction),
  "state": enum (State),
  "retentionExpireTime": string,
  "triggeredRules": [
    {
      object (TriggeredRule)
    }
  ],
  "content": {
    object (MessageContent)
  },
  "rawMessage": string
}
Поля
name

string

Идентификатор. Название ресурса сообщения, помещенного в карантин. Формат: customers/{customer_id}/quarantinedMessages/{quarantined_message_id}
messageId

string

Только для вывода. Неизменяемый идентификатор сообщения Gmail.
messageOwner

string

Только для вывода. Адрес электронной почты владельца этого сообщения.
quarantines[]

string

Только для вывода. Названия ресурсов карантинов, к которым относится это сообщение. Формат: customers/{customer_id}/quarantines/{quarantine_id}
receiveTime

string (Timestamp format)

Только для вывода. Временная метка получения сообщения.
direction

enum (Direction)

Только для вывода. Направление сообщения (например, INBOUND, OUTBOUND).
state

enum (State)

Только для вывода. Текущий статус обработки сообщения.
retentionExpireTime

string (Timestamp format)

Только для вывода. Временная метка, до которой будет храниться это сообщение.
triggeredRules[]

object (TriggeredRule)

Только для вывода. Информация о правилах, из-за которых письмо попало в карантин.
content

object (MessageContent)

Только для вывода. Подробное содержание и метаданные письма, помещенного в карантин.
rawMessage

string (bytes format)

Только для вывода. Все электронное письмо в строке, отформатированной по стандарту RFC 2822 и закодированной по стандарту base64url. Возвращается, если выбран тип контента RAW.

Направление

Направление сообщения.

Перечисления
DIRECTION_UNSPECIFIED Не указано.
INBOUND Пользователь получил сообщение, помещенное в карантин.
OUTBOUND Пользователь отправил сообщение, которое было помещено в карантин.

Штат

Текущий статус обработки сообщения.

Перечисления
STATE_UNSPECIFIED Не указано.
PENDING_TRIAGE Сообщение находится в карантине.
RELEASED Сообщение было перемещено из карантина.
DENIED Сообщение было отклонено, пока находилось в карантине.

TriggeredRule

Информация о правиле, из-за которого сообщение было помещено в карантин.

JSON-представление 
{
  "policyId": string,
  "ruleId": string,
  "displayName": string
}
Поля
policyId

string

Идентификатор правила, с которым соотносится установленное правило.
ruleId

string

Идентификатор определенного установленного правила.
displayName

string

Название или описание установленного правила.

MessageContent

Подробная информация о содержимом электронного письма, помещенного в карантин.

JSON-представление 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "body": string,
  "subject": string,
  "labels": [
    string
  ],
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
Поля
headers[]

object (Header)

Заголовки электронного письма.
attachments[]

object (Attachment)

Прикрепленные файлы, найденные в электронном письме.
body

string

Текст или фрагмент электронного письма в формате обычного текста.
subject

string

Тема электронного письма.
labels[]

string

Стандартные ярлыки, примененные к письму (например, "КАРАНТИН").
classificationLabelValues[]

object (ClassificationLabelValue)

Значения ярлыков классификации, примененные к сообщению. Доступно только для аккаунтов Google Workspace.

Прикрепленный файл

Прикрепленный файл в электронном письме.

JSON-представление 
{
  "filename": string,
  "mimeType": string,
  "sizeBytes": string,
  "attachmentId": string
}
Поля
filename

string

Название прикрепленного файла.
mimeType

string

MIME-тип прикрепленного файла (например, "application/pdf").
sizeBytes

string (int64 format)

Размер прикрепленного файла в байтах.
attachmentId

string

Уникальный идентификатор, используемый для получения контента прикрепленного файла.

ClassificationLabelValue

Ярлыки классификации, примененные к электронному письму.

JSON-представление 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Поля
labelId

string

Канонический или необработанный буквенно-цифровой идентификатор ярлыка классификации.
fields[]

object (ClassificationLabelFieldValue)

Значения полей для заданного идентификатора ярлыка классификации.

ClassificationLabelFieldValue

Значения полей для ярлыка классификации.

JSON-представление 
{
  "fieldId": string,
  "selection": string
}
Поля
fieldId

string

Идентификатор поля для значения ярлыка классификации.
selection

string

Идентификатор варианта выбора.

Методы

batchDeny

 Асинхронно запрещает список сообщений.

batchRelease

 Асинхронно выпускает список сообщений.

deny

 Отклоняет сообщение из карантина.

get

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

list

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

release

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