Class GmailMessage

GmailMessage

Сообщение в учетной записи Gmail пользователя.

Методы

Метод Тип возвращаемого значения Краткое описание
create Draft Reply(body) Gmail Draft Создает черновик сообщения в ответ на это сообщение, используя адрес для ответа.
create Draft Reply(body, options) Gmail Draft Создает черновик сообщения в ответ отправителю данного сообщения, используя адрес для ответа, а также необязательные аргументы.
create Draft Reply All(body) Gmail Draft Создает черновик сообщения в ответ отправителю, используя адрес для ответа и всех получателей этого сообщения.
create Draft Reply All(body, options) Gmail Draft Создает черновик сообщения в ответ отправителю данного сообщения, используя адрес для ответа и всех получателей, а также необязательные аргументы.
forward(recipient) Gmail Message Пересылает это сообщение новым получателям.
forward(recipient, options) Gmail Message Пересылает это сообщение новым получателям, с возможностью добавления дополнительных аргументов.
get Attachments() Gmail Attachment[] Получает все вложения к этому сообщению.
get Attachments(options) Gmail Attachment[] Получает все вложения к этому сообщению.
get Bcc() String Добавляет получателей, разделённых запятыми, в скрытую копию этого сообщения.
get Body() String Получает HTML-содержимое тела этого сообщения.
get Cc() String Добавляет получателей, разделённых запятыми, в копию этого сообщения.
get Date() Date Получает дату и время этого сообщения.
get From() String Получает отправителя этого сообщения.
get Header(name) String Получает значение заголовка RFC 2822 по имени заголовка.
get Id() String Получает идентификатор этого сообщения.
get Plain Body() String Получает содержимое тела сообщения без форматирования HTML.
get Raw Content() String Получает исходное содержимое этого сообщения.
get Reply To() String Получает адрес отправителя этого сообщения (обычно это адрес, на который следует ответить).
get Subject() String Получает тему этого сообщения.
get Thread() Gmail Thread Получает поток, содержащий это сообщение.
get To() String Получает список получателей этого сообщения, разделённых запятыми.
is Draft() Boolean Определяет, является ли это сообщение черновиком.
is In Chats() Boolean Определяет, является ли это сообщение сообщением в чате.
is In Inbox() Boolean Определяет, находится ли это сообщение во входящих сообщениях.
is In Priority Inbox() Boolean Возвращает true если это сообщение находится в папке «Входящие» с приоритетом; в противном случае возвращает false .
is In Trash() Boolean Выясняет, находится ли это сообщение в корзине.
is Starred() Boolean Выводит информацию о том, отмечено ли это сообщение звездочкой.
is Unread() Boolean Определяет, является ли это сообщение непрочитанным.
mark Read() Gmail Message Помечает сообщение как прочитанное.
mark Unread() Gmail Message Помечает сообщение как непрочитанное.
move To Trash() Gmail Message Перемещает сообщение в корзину.
refresh() Gmail Message Перезагружает это сообщение и связанное с ним состояние из Gmail (полезно, если изменились метки, статус прочтения и т. д.).
reply(body) Gmail Message Replies to the sender of this message using the reply-to address.
reply(body, options) Gmail Message Отвечает отправителю этого сообщения, используя адрес для ответа, с необязательными аргументами.
reply All(body) Gmail Message Ответы отправляются отправителю по адресу для ответа, а также всем получателям этого сообщения.
reply All(body, options) Gmail Message Отвечает отправителю этого сообщения, используя адрес для ответа и всех получателей, а также необязательные аргументы.
star() Gmail Message Отмечает сообщение звездочками.
unstar() Gmail Message Снимает отметку со сообщения.

Подробная документация

createDraftReply(body)

Создает черновик сообщения в ответ отправителю данного сообщения, используя адрес для ответа. Размер электронного письма (включая заголовки) ограничен квотой .

// Create a draft reply to the original message with an acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('Got your message');

Параметры

Имя Тип Описание
body String Текст электронного письма.

Возвращаться

GmailDraft — Только что созданное черновик сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


createDraftReply(body, options)

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

Электронное письмо может содержать как обычный текст, так и HTML-тему. Размер электронного письма (включая заголовки) ограничен установленной квотой .

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

Параметры

Имя Тип Описание
body String Текст электронного письма.
options Object Объект JavaScript, определяющий дополнительные параметры, перечисленные ниже.

Расширенные параметры

Имя Тип Описание
attachments Blob Source[] массив файлов для отправки вместе с электронным письмом
bcc String Список адресов электронной почты, разделенных запятыми, для добавления в скрытую копию (BCC).
cc String Список адресов электронной почты, разделенных запятыми, для указания в копии.
from String Адрес, с которого должно быть отправлено электронное письмо, должен совпадать с одним из значений, возвращаемых функцией Gmail App.getAliases()
html Body String Если этот параметр задан, устройства, способные отображать HTML, используют его вместо обязательного аргумента body; вы можете добавить необязательное поле inline Images в тело HTML-сообщения, если у вас есть встроенные изображения для ваших писем.
inline Images Object Объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( Blob Source ); предполагается, что используется параметр html Body , и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String Имя отправителя электронного письма (по умолчанию: имя пользователя)
reply To String Адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя).
subject String Новая тема письма, до 250 символов.

Возвращаться

GmailDraft — Только что созданное черновик сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


createDraftReplyAll(body)

Создает черновик сообщения в ответ отправителю, используя адрес для ответа и всех получателей этого сообщения. Размер электронного письма (включая заголовки) ограничен квотой .

// Create a draft response to all recipients (except those bcc'd) with an
// acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

Параметры

Имя Тип Описание
body String Текст электронного письма.

Возвращаться

GmailDraft — Только что созданное черновик сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


createDraftReplyAll(body, options)

Создает черновик сообщения в ответ отправителю данного сообщения, используя адрес для ответа и всех получателей, а также необязательные аргументы.

Электронное письмо может содержать как обычный текст, так и HTML-тему. Размер электронного письма (включая заголовки) ограничен установленной квотой .

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

Параметры

Имя Тип Описание
body String Текст электронного письма.
options Object Объект JavaScript, определяющий дополнительные параметры, перечисленные ниже.

Расширенные параметры

Имя Тип Описание
attachments Blob Source[] массив файлов для отправки вместе с электронным письмом
bcc String Список адресов электронной почты, разделенных запятыми, для добавления в скрытую копию (BCC).
cc String Список адресов электронной почты, разделенных запятыми, для указания в копии.
from String Адрес, с которого должно быть отправлено электронное письмо, должен совпадать с одним из значений, возвращаемых функцией Gmail App.getAliases()
html Body String Если этот параметр задан, устройства, способные отображать HTML, используют его вместо обязательного аргумента body; вы можете добавить необязательное поле inline Images в тело HTML-сообщения, если у вас есть встроенные изображения для ваших писем.
inline Images Object Объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( Blob Source ); предполагается, что используется параметр html Body , и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String Имя отправителя электронного письма (по умолчанию: имя пользователя)
reply To String Адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя).
subject String Новая тема письма, до 250 символов.

Возвращаться

GmailDraft — Только что созданное черновик сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


forward(recipient)

Пересылает это сообщение новым получателям. Размер электронного письма (включая заголовки) ограничен установленной квотой .

// Forward first message of first inbox thread to recipient1 & recipient2,
// both @example.com
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('recipient1@example.com,recipient2@example.com');

Параметры

Имя Тип Описание
recipient String Список адресов электронной почты, разделенных запятыми.

Возвращаться

GmailMessage — Это сообщение полезно для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


forward(recipient, options)

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

Электронное письмо может содержать как обычный текст, так и HTML-тему. Размер электронного письма (включая заголовки) ограничен установленной квотой .

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('recipient1@example.com,recipient2@example.com', {
  cc: 'myboss@example.com',
  bcc: 'mybosses-boss@example.com,vp@example.com',
});

Параметры

Имя Тип Описание
recipient String A comma-separated list of email addresses.
options Object Объект JavaScript, определяющий дополнительные параметры, перечисленные ниже.

Расширенные параметры

Имя Тип Описание
attachments Blob Source[] массив файлов для отправки вместе с электронным письмом
bcc String Список адресов электронной почты, разделенных запятыми, для добавления в скрытую копию (BCC).
cc String Список адресов электронной почты, разделенных запятыми, для указания в копии.
from String Адрес, с которого должно быть отправлено электронное письмо, должен совпадать с одним из значений, возвращаемых функцией Gmail App.getAliases()
html Body String Если этот параметр задан, устройства, способные отображать HTML, используют его вместо обязательного аргумента body; вы можете добавить необязательное поле inline Images в тело HTML-сообщения, если у вас есть встроенные изображения для ваших писем.
inline Images Object Объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( Blob Source ); предполагается, что используется параметр html Body , и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String Имя отправителя электронного письма (по умолчанию: имя пользователя)
no Reply Boolean true указывает, следует ли отправлять электронное письмо с общего адреса электронной почты, на который нельзя ответить, чтобы отбить у получателей желание отвечать на письма; эта опция доступна только для учетных записей Google Workspace, а не для пользователей Gmail.
reply To String Адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя).
subject String Новая тема письма, до 250 символов.

Возвращаться

GmailMessage — Это сообщение полезно для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


getAttachments()

Получает все вложения к этому сообщению.

Возвращаться

GmailAttachment[] — Массив вложений типа Blob для этого сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getAttachments(options)

Получает все вложения к этому сообщению.

Параметры

Имя Тип Описание
options Object Объект JavaScript, определяющий дополнительные параметры, перечисленные ниже.

Расширенные параметры

Имя Тип Описание
include Inline Images Boolean true указывает, что возвращаемый массив вложений Blob должен включать встроенные изображения (по умолчанию — true ).
include Attachments Boolean true указывает, что возвращаемый массив вложений Blob должен включать обычные (не встроенные) вложения (по умолчанию — true ).

Возвращаться

GmailAttachment[] — Массив вложений типа Blob для этого сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getBcc()

Добавляет получателей, разделённых запятыми, в скрытую копию этого сообщения.

По определению, это поле пустое для всех полученных сообщений.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBcc());                      // Log bcc'd addresses

Возвращаться

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

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


getBody()

Получает HTML-содержимое тела этого сообщения.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBody());                     // Log contents of the body

Возвращаться

String — Содержимое тела этого сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


getCc()

Добавляет получателей, разделённых запятыми, в копию этого сообщения.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getCc());                       // Log cc'd addresses

Возвращаться

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

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


getDate()

Получает дату и время этого сообщения.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getDate());  // Log date and time of the message

Возвращаться

Date — Дата и время этого сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getFrom()

Получает отправителя этого сообщения.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getFrom());  // Log from address of the message

Возвращаться

String — Адрес электронной почты отправителя сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


getHeader(name)

Получает значение заголовка RFC 2822 по имени заголовка.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const message = thread.getMessages()[0];           // Get the first message.
Logger.log(
    message.getHeader('Message-ID'));  // Logs the Message-ID RFC 2822 header.

Параметры

Имя Тип Описание
name String Название заголовка RFC, без двоеточия, отделяющего его от значения.

Возвращаться

String — значение заголовка или пустая строка, если заголовок отсутствует в сообщении.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getId()

Gets the ID of this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
const id = message.getId();
const messageById = GmailApp.getMessageById(id);
Logger.log(
    message.getSubject() === messageById.getMessage());  // Always logs true

Возвращаться

String — Идентификатор сообщения.


getPlainBody()

Получает содержимое тела сообщения без HTML-форматирования. Это более сложный метод, чем getBody() , и занимает больше времени.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getPlainBody());                // Log contents of the body

Возвращаться

String — Простое содержимое тела этого сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


getRawContent()

Получает исходное содержимое этого сообщения. Это эквивалентно функции «Показать оригинал» в пользовательском интерфейсе Gmail.

Возвращаться

String — Исходное содержимое этого сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getReplyTo()

Получает адрес отправителя этого сообщения (обычно это адрес, на который следует ответить).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getReplyTo());                  // Logs reply-to address

Возвращаться

String — Адрес электронной почты для ответов.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


getSubject()

Получает тему этого сообщения.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getSubject());                  // Log subject line

Возвращаться

String — Тема данного сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


getThread()

Gets the thread that contains this message.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(
    message.getThread().getFirstMessageSubject() ===
        thread.getFirstMessageSubject(),
);  // Always logs true

Возвращаться

GmailThread — Ветка GmailThread, содержащая это сообщение.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getTo()

Получает список получателей этого сообщения, разделённых запятыми.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getTo());  // Log the recipient of message

Возвращаться

String — Получатели этого сообщения, разделённые запятыми.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


isDraft()

Определяет, является ли это сообщение черновиком.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

Возвращаться

Boolean — Является ли это сообщение черновиком.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

isInChats()

Определяет, является ли это сообщение сообщением в чате.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

Возвращаться

Boolean — указывает, является ли это сообщение сообщением в чате.


isInInbox()

Определяет, находится ли это сообщение во входящих сообщениях.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

Возвращаться

Boolean — Указывает, находится ли это сообщение во входящих сообщениях.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

isInPriorityInbox()

Возвращает true если это сообщение находится в папке «Входящие» с приоритетом; в противном случае возвращает false .

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log(`is in priority inbox? ${messages[i].isInPriorityInbox()}`);
}

Возвращаться

Boolean — Указывает, находится ли это сообщение в папке «Приоритетные входящие».

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

isInTrash()

Выясняет, находится ли это сообщение в корзине.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

Возвращаться

Boolean — Указывает, будет ли это сообщение отправлено в корзину.


isStarred()

Выводит информацию о том, отмечено ли это сообщение звездочкой.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

Возвращаться

Boolean — Помечено ли это сообщение звездочкой.


isUnread()

Определяет, является ли это сообщение непрочитанным.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

Возвращаться

Boolean — статус непрочитанного сообщения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

markRead()

Помечает сообщение как прочитанное.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markRead();                                // Mark as read

Возвращаться

GmailMessage — Это сообщение GmailMessage, полезное для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


markUnread()

Помечает сообщение как непрочитанное.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markUnread();                              // Mark as unread

Возвращаться

GmailMessage — Это сообщение GmailMessage, полезное для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


moveToTrash()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.moveToTrash();                             // Move message to trash

Возвращаться

GmailMessage — Это сообщение GmailMessage, полезное для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


refresh()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
// .. Do bunch of stuff here
message.refresh();  // Make sure it's up to date
// Do more stuff to message

Возвращаться

GmailMessage — Это сообщение для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

reply(body)

Ответы отправителю этого сообщения направляются по адресу, указанному в поле "Ответить". Размер электронного письма (включая заголовки) ограничен установленной квотой .

// Respond to author of message with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('Got your message');

Параметры

Имя Тип Описание
body String Текст электронного письма.

Возвращаться

GmailMessage — Это сообщение полезно для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


reply(body, options)

Отвечает отправителю этого сообщения, используя адрес для ответа, с необязательными аргументами.

Электронное письмо может содержать как обычный текст, так и HTML-тему. Размер электронного письма (включая заголовки) ограничен установленной квотой .

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

Параметры

Имя Тип Описание
body String Текст электронного письма.
options Object Объект JavaScript, определяющий дополнительные параметры, перечисленные ниже.

Расширенные параметры

Имя Тип Описание
attachments Blob Source[] массив файлов для отправки вместе с электронным письмом
bcc String Список адресов электронной почты, разделенных запятыми, для добавления в скрытую копию (BCC).
cc String Список адресов электронной почты, разделенных запятыми, для указания в копии.
from String Адрес, с которого должно быть отправлено электронное письмо, должен совпадать с одним из значений, возвращаемых функцией Gmail App.getAliases()
html Body String Если этот параметр задан, устройства, способные отображать HTML, используют его вместо обязательного аргумента body; вы можете добавить необязательное поле inline Images в тело HTML-сообщения, если у вас есть встроенные изображения для ваших писем.
inline Images Object Объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( Blob Source ); предполагается, что используется параметр html Body , и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String Имя отправителя электронного письма (по умолчанию: имя пользователя)
no Reply Boolean true указывает, следует ли отправлять электронное письмо с общего адреса электронной почты, на который нельзя ответить, чтобы отбить у получателей желание отвечать на письма; эта опция доступна только для учетных записей Google Workspace, а не для пользователей Gmail.
reply To String Адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя).
subject String Новая тема письма, до 250 символов.

Возвращаться

GmailMessage — Это сообщение полезно для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


replyAll(body)

Ответы отправляются отправителю по адресу для ответа и всем получателям этого сообщения. Размер электронного письма (включая заголовки) ограничен квотой .

// Respond to all recipients (except bcc'd) of last email in thread with
// acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('Got your message');

Параметры

Имя Тип Описание
body String Текст электронного письма.

Возвращаться

GmailMessage — Это сообщение полезно для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


replyAll(body, options)

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

Электронное письмо может содержать как обычный текст, так и HTML-тему. Размер электронного письма (включая заголовки) ограничен установленной квотой .

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

Параметры

Имя Тип Описание
body String Текст электронного письма.
options Object Объект JavaScript, определяющий дополнительные параметры, перечисленные ниже.

Расширенные параметры

Имя Тип Описание
attachments Blob Source[] массив файлов для отправки вместе с электронным письмом
bcc String Список адресов электронной почты, разделенных запятыми, для добавления в скрытую копию (BCC).
cc String Список адресов электронной почты, разделенных запятыми, для указания в копии.
from String Адрес, с которого должно быть отправлено электронное письмо, должен совпадать с одним из значений, возвращаемых функцией Gmail App.getAliases()
html Body String Если этот параметр задан, устройства, способные отображать HTML, используют его вместо обязательного аргумента body; вы можете добавить необязательное поле inline Images в тело HTML-сообщения, если у вас есть встроенные изображения для ваших писем.
inline Images Object Объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( Blob Source ); предполагается, что используется параметр html Body , и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String Имя отправителя электронного письма (по умолчанию: имя пользователя)
no Reply Boolean true указывает, следует ли отправлять электронное письмо с общего адреса электронной почты, на который нельзя ответить, чтобы отбить у получателей желание отвечать на письма; эта опция доступна только для учетных записей Google Workspace, а не для пользователей Gmail.
reply To String Адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя).
subject String Новая тема письма, до 250 символов.

Возвращаться

GmailMessage — Это сообщение полезно для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


star()

Отмечает сообщение звездочками.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.star();                                    // Star the message

Возвращаться

GmailMessage — Это сообщение GmailMessage, полезное для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также


unstar()

Снимает отметку со сообщения.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.unstar();                                  // Unstar the message

Возвращаться

GmailMessage — Это сообщение GmailMessage, полезное для создания цепочек сообщений.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также