REST Resource: users.messages

Источник: Сообщение

Электронное письмо.

JSON-представление 
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
Поля
id

string

Неизменяемый идентификатор сообщения.

threadId

string

Идентификатор ветки обсуждения, к которой относится сообщение. Для добавления сообщения или черновика в ветку обсуждения необходимо соблюдение следующих условий:

  1. Запрашиваемый threadId должен быть указан в Message или Draft.Message которое вы предоставляете вместе с запросом.
  2. Заголовки References и In-Reply-To должны быть установлены в соответствии со стандартом RFC 2822 .
  3. Заголовки Subject должны совпадать.

labelIds[]

string

Список идентификаторов меток, примененных к этому сообщению.

snippet

string

Небольшой фрагмент текста сообщения.

historyId

string

Идентификатор последней записи в истории, которая внесла изменения в это сообщение.

internalDate

string ( int64 format)

Внутренняя метка времени создания сообщения (эпоха миллисекунд), определяющая порядок входящих сообщений. Для обычных писем, полученных по протоколу SMTP, это время первоначального принятия сообщения Google, что более надежно, чем заголовок Date . Однако для почты, перенесенной через API, клиент может настроить ее на основе заголовка Date .

payload

object ( MessagePart )

Структура разобранных электронных писем в частях сообщения.

sizeEstimate

integer

Примерный размер сообщения в байтах.

raw

string ( bytes format)

Полное сообщение электронной почты в формате RFC 2822, закодированное в base64url. Возвращается в ответах messages.get и drafts.get , если указан параметр format=RAW .

Строка, закодированная в формате Base64.

classificationLabelValues[]

object ( ClassificationLabelValue )

Значения меток классификации в сообщении. Доступные схемы меток классификации можно запросить с помощью API меток Google Drive. Идентификатор каждой метки классификации должен быть уникальным. Если указаны повторяющиеся идентификаторы, будет сохранен только один, и выбор будет произвольным. Используется только для учетных записей Google Workspace. Существует ограничение в 20 значений меток классификации на один запрос. Если количество значений меток классификации превышает максимально допустимое число, запрос завершается с ошибкой.

MessagePart

Отдельная часть MIME-сообщения.

JSON-представление 
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
Поля
partId

string

Неизменяемый идентификатор части сообщения.

mimeType

string

MIME-тип части сообщения.

filename

string

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

headers[]

object ( Header )

Список заголовков в этой части сообщения. Для части сообщения верхнего уровня, представляющей собой всю полезную нагрузку сообщения, будут содержаться стандартные заголовки электронной почты RFC 2822, такие как To , From » и Subject .

body

object ( MessagePartBody )

Тело сообщения, которое может быть пустым для частей MIME-сообщений контейнера.

parts[]

object ( MessagePart )

Дочерние MIME-части этого раздела. Это относится только к MIME-частям контейнера, например, multipart/* . Для MIME-частей, не являющихся контейнерными, таких как text/plain , это поле пустое. Для получения дополнительной информации см. RFC 1521 .

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

string

Название заголовка перед разделителем : ". Например, To .

value

string

Значение заголовка после разделителя : . Например, someuser@example.com .

ClassificationLabelValue

Метки классификации, применяемые к электронному письму. Метки классификации отличаются от меток входящих сообщений Gmail. Используются только для учетных записей Google Workspace. Подробнее о метках классификации .

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

string

Обязательно. Канонический или необработанный буквенно-цифровой идентификатор классификационной метки. Сопоставляется с полем ID ресурса «Метка» в Google Диска.

fields[]

object ( ClassificationLabelFieldValue )

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

КлассификацияМеткиПолеЗначение

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

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

string

Обязательно. Идентификатор поля для значения метки классификации. Сопоставляется с полем ID объекта Label.Field в Google Drive.

selection

string

Идентификатор варианта выбора для параметра выбора. Должен быть установлен только в том случае, если тип поля — SELECTION в объекте Google Drive Label.Field . Сопоставляется с полем id ресурса Google Drive Label.Field.SelectionOptions .

Методы

batchDelete

 Удаляет множество сообщений по идентификатору сообщения.

batchModify

 Изменяет метки и значения меток классификации в указанных сообщениях.

delete

 Немедленно и навсегда удаляет указанное сообщение.

get

 Получает указанное сообщение.

import

 Импортирует сообщение только в почтовый ящик этого пользователя, выполняя стандартное сканирование и классификацию доставки электронной почты, аналогичное получению через SMTP.

insert

 Эта команда напрямую вставляет сообщение только в почтовый ящик этого пользователя, аналогично IMAP APPEND , минуя большинство проверок и классификации.

list

 Отображает список сообщений в почтовом ящике пользователя.

modify

 Изменяет значения меток и меток классификации в указанном сообщении.

send

 Отправляет указанное сообщение получателям, указанным в заголовках To , Cc и Bcc .

trash

 Перемещает указанное сообщение в корзину.

untrash

 Удаляет указанное сообщение из корзины.