Class GmailMessage

Сообщение Gmail

Сообщение в учетной записи 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 Ответы отправителю этого сообщения с использованием адреса для ответа.
reply(body, options) Gmail Message Отвечает отправителю этого сообщения с использованием адреса для ответа и необязательных аргументов.
reply All(body) Gmail Message Ответ отправителю с использованием адреса ответа и всех получателей этого сообщения.
reply All(body, options) Gmail Message Отвечает отправителю этого сообщения, используя адрес для ответа и всех получателей, с необязательными аргументами.
star() Gmail Message Помечает сообщение.
unstar() Gmail Message Снимает пометку с сообщения.

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

create Draft Reply(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 Тело письма.

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

Gmail Draft — вновь созданный черновик сообщения.

Авторизация

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

  • https://mail.google.com/

См. также

create Draft Reply(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 список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых Gmail App.getAliases()
html Body String если этот параметр установлен, устройства, способные отображать HTML, используют его вместо обязательного аргумента тела; вы можете добавить дополнительное inline Images в тело HTML, если у вас есть встроенные изображения для вашего электронного письма.
inline Images Object объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( Blob Source ); при этом предполагается, что используется параметр html Body и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String имя отправителя электронного письма (по умолчанию: имя пользователя)
reply To String адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя)
subject String Новая тема письма длиной до 250 символов.

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

Gmail Draft — вновь созданный черновик сообщения.

Авторизация

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

  • https://mail.google.com/

См. также

create Draft Reply All(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 Тело письма.

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

Gmail Draft — вновь созданный черновик сообщения.

Авторизация

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

  • https://mail.google.com/

См. также

create Draft Reply All(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 список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых Gmail App.getAliases()
html Body String если этот параметр установлен, устройства, способные отображать HTML, используют его вместо обязательного аргумента тела; вы можете добавить дополнительное inline Images в тело HTML, если у вас есть встроенные изображения для вашего электронного письма.
inline Images Object объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( Blob Source ); при этом предполагается, что используется параметр html Body и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String имя отправителя электронного письма (по умолчанию: имя пользователя)
reply To String адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя)
subject String Новая тема письма длиной до 250 символов.

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

Gmail Draft — вновь созданный черновик сообщения.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего 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 Список адресов электронной почты, разделенный запятыми.

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

Gmail Message — это сообщение полезно для создания цепочек.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего 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 Список адресов электронной почты, разделенный запятыми.
options Object Объект JavaScript, задающий дополнительные параметры, как указано ниже.

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

Имя Тип Описание
attachments Blob Source[] массив файлов для отправки по электронной почте
bcc String список адресов электронной почты, разделенных запятыми, для BCC
cc String список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых Gmail App.getAliases()
html Body String если этот параметр установлен, устройства, способные отображать HTML, используют его вместо обязательного аргумента тела; вы можете добавить дополнительное 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 символов.

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

Gmail Message — это сообщение полезно для создания цепочек.

Авторизация

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

  • https://mail.google.com/

См. также

get Attachments()

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

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

Gmail Attachment[] — массив вложений Blob для этого сообщения.

Авторизация

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

  • https://mail.google.com/

get Attachments(options)

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

Параметры

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

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

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

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

Gmail Attachment[] — массив вложений Blob для этого сообщения.

Авторизация

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

  • https://mail.google.com/

get Bcc()

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

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

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/

См. также

get Body()

Получает 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/

См. также

get Cc()

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

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/

См. также

get Date()

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

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/

get From()

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

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/

См. также

get Header(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/

get Id()

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

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 — идентификатор сообщения.

get Plain Body()

Получает содержимое тела этого сообщения без форматирования HTML. Это сложнее, чем get Body() , и занимает больше времени. 

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/

См. также

get Raw Content()

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

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

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

Авторизация

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

  • https://mail.google.com/

get Reply To()

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

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/

См. также

get Subject()

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

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/

См. также

get Thread()

Получает поток, содержащий это сообщение. 

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

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

Gmail Thread — GmailThread, содержащий это сообщение.

Авторизация

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

  • https://mail.google.com/

get To()

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

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/

См. также

is Draft()

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

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/

is In Chats()

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

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 — является ли это сообщение чатом.

is In Inbox()

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

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/

is In Priority Inbox()

Возвращает 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/

is In Trash()

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

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 — находится ли это сообщение в корзине.

is Starred()

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

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 — Помечено ли это сообщение.

is Unread()

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

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/

mark Read()

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

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

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

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

Авторизация

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

  • https://mail.google.com/

См. также

mark Unread()

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

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

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

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

Авторизация

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

  • https://mail.google.com/

См. также

move To Trash()

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

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

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

Gmail Message — это сообщение 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

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

Gmail Message — это сообщение для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего 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 Тело письма.

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

Gmail Message — это сообщение полезно для создания цепочек.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего 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 список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых Gmail App.getAliases()
html Body String если этот параметр установлен, устройства, способные отображать HTML, используют его вместо обязательного аргумента тела; вы можете добавить дополнительное 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 символов.

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

Gmail Message — это сообщение полезно для создания цепочек.

Авторизация

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

  • https://mail.google.com/

См. также

reply All(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 Тело письма.

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

Gmail Message — это сообщение полезно для создания цепочек.

Авторизация

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

  • https://mail.google.com/

См. также

reply All(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 список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых Gmail App.getAliases()
html Body String если этот параметр установлен, устройства, способные отображать HTML, используют его вместо обязательного аргумента тела; вы можете добавить дополнительное 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 символов.

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

Gmail Message — это сообщение полезно для создания цепочек.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего 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

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

Gmail Message — это сообщение 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

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

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

Авторизация

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

  • https://mail.google.com/

См. также