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 Диска. Каждый идентификатор метки классификации должен быть уникальным. Если указаны повторяющиеся идентификаторы, будет сохранен только один, а выбор произволен. Используется только для учётных записей Google Workspace.

Часть сообщения

Отдельная часть сообщения 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 .

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

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

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

string

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

fields[]

object ( ClassificationLabelFieldValue )

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

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

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

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

string

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

selection

string

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

Методы

batchDelete

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

batchModify

 Изменяет метки указанных сообщений.

delete

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

get

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

import

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

insert

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

list

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

modify

 Изменяет метки указанного сообщения.

send

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

trash

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

untrash

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