Class GmailApp

GmailApp

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

Методы

Метод Тип возврата Краткое описание
createDraft(recipient, subject, body) GmailDraft Создает черновик сообщения электронной почты.
createDraft(recipient, subject, body, options) GmailDraft Создает черновик сообщения электронной почты с необязательными аргументами.
createLabel(name) GmailLabel Создайте новую метку пользователя с данным именем.
deleteLabel(label) GmailApp Удаляет указанную метку.
getAliases() String[] Получает список адресов электронной почты, настроенных в качестве псевдонимов для этой учетной записи в Gmail.
getDraft(draftId) GmailDraft Получить черновик сообщения электронной почты по идентификатору.
getDraftMessages() GmailMessage[] Извлекает все черновики сообщений.
getDrafts() GmailDraft[] Получает все черновики сообщений Gmail.
getInboxThreads() GmailThread[] Извлекает все ветки папки «Входящие» независимо от меток.
getInboxThreads(start, max) GmailThread[] Извлекает диапазон веток папки «Входящие» независимо от меток.
getInboxUnreadCount() Integer Получает количество непрочитанных цепочек в папке «Входящие».
getMessageById(id) GmailMessage Получает сообщение по идентификатору.
getMessagesForThread(thread) GmailMessage[] Получить все сообщения в указанном потоке.
getMessagesForThreads(threads) GmailMessage[][] Получить все сообщения в указанных потоках.
getPriorityInboxThreads() GmailThread[] Извлекает все цепочки приоритетных входящих независимо от меток.
getPriorityInboxThreads(start, max) GmailThread[] Извлекает ряд цепочек приоритетных входящих независимо от меток.
getPriorityInboxUnreadCount() Integer Получает количество непрочитанных цепочек в папке «Приоритетные входящие».
getSpamThreads() GmailThread[] Извлекает все спам-темы независимо от меток.
getSpamThreads(start, max) GmailThread[] Извлекает ряд спам-сообщений независимо от меток.
getSpamUnreadCount() Integer Получает количество непрочитанных тем, являющихся спамом.
getStarredThreads() GmailThread[] Извлекает все помеченные темы независимо от меток.
getStarredThreads(start, max) GmailThread[] Извлекает диапазон отмеченных тем независимо от меток.
getStarredUnreadCount() Integer Получает количество помеченных непрочитанных тем.
getThreadById(id) GmailThread Получает поток по идентификатору.
getTrashThreads() GmailThread[] Извлекает все мусорные темы независимо от меток.
getTrashThreads(start, max) GmailThread[] Извлекает ряд мусорных потоков независимо от меток.
getUserLabelByName(name) GmailLabel Получает метку по ее имени.
getUserLabels() GmailLabel[] Получает список меток, созданных пользователем.
markMessageRead(message) GmailApp Отмечает это сообщение как прочитанное и принудительно обновляет его.
markMessageUnread(message) GmailApp Помечает это сообщение как непрочитанное и принудительно обновляет сообщение.
markMessagesRead(messages) GmailApp Помечает эти сообщения как прочитанные и принудительно обновляет сообщения.
markMessagesUnread(messages) GmailApp Помечает эти сообщения как непрочитанные и принудительно обновляет сообщения.
markThreadImportant(thread) GmailApp Отмечает эту тему как важную и принудительно обновляет ее.
markThreadRead(thread) GmailApp Помечает эту тему как прочитанную и принудительно обновляет ее.
markThreadUnimportant(thread) GmailApp Помечает этот поток как неважный и принудительно обновляет поток.
markThreadUnread(thread) GmailApp Помечает эту тему как непрочитанную и принудительно обновляет ее.
markThreadsImportant(threads) GmailApp Помечает эти темы как важные и принудительно обновляет их.
markThreadsRead(threads) GmailApp Помечает эти потоки как прочитанные и принудительно обновляет потоки.
markThreadsUnimportant(threads) GmailApp Помечает эти потоки как неважные и принудительно обновляет их.
markThreadsUnread(threads) GmailApp Помечает эти темы как непрочитанные и принудительно обновляет их.
moveMessageToTrash(message) GmailApp Перемещает сообщение в корзину и принудительно обновляет сообщение.
moveMessagesToTrash(messages) GmailApp Перемещает указанные сообщения в корзину и принудительно обновляет сообщения.
moveThreadToArchive(thread) GmailApp Перемещает этот поток в архив и принудительно обновляет поток.
moveThreadToInbox(thread) GmailApp Перемещает эту цепочку в папку «Входящие» и принудительно ее обновляет.
moveThreadToSpam(thread) GmailApp Перемещает эту тему в спам и принудительно обновляет ее.
moveThreadToTrash(thread) GmailApp Перемещает эту тему в корзину и принудительно обновляет ее.
moveThreadsToArchive(threads) GmailApp Перемещает эти потоки в архив и принудительно обновляет потоки.
moveThreadsToInbox(threads) GmailApp Перемещает эти темы во входящие и принудительно обновляет их.
moveThreadsToSpam(threads) GmailApp Перемещает эти темы в спам и принудительно обновляет их.
moveThreadsToTrash(threads) GmailApp Перемещает эти потоки в корзину и принудительно обновляет потоки.
refreshMessage(message) GmailApp Перезагружает сообщение и связанное с ним состояние из Gmail (полезно, если изменились метки, состояние чтения и т. д.).
refreshMessages(messages) GmailApp Перезагружает сообщения и связанное с ними состояние из Gmail (полезно, если изменились метки, состояние чтения и т. д.).
refreshThread(thread) GmailApp Перезагружает цепочку и связанное с ней состояние из Gmail (полезно, если изменились метки, состояние чтения и т. д.).
refreshThreads(threads) GmailApp Перезагружает потоки и связанное с ними состояние из Gmail (полезно, если изменились метки, состояние чтения и т. д.).
search(query) GmailThread[] Найдите Gmail по заданному запросу.
search(query, start, max) GmailThread[] Найдите Gmail по заданному запросу.
sendEmail(recipient, subject, body) GmailApp Отправляет сообщение электронной почты.
sendEmail(recipient, subject, body, options) GmailApp Отправляет сообщение электронной почты с необязательными аргументами.
setCurrentMessageAccessToken(accessToken) void Устанавливает токен доступа к текущему сообщению , который позволяет сценарию получать доступ к текущим свойствам GmailMessage .
starMessage(message) GmailApp Добавляет звездочку к этому сообщению и принудительно обновляет сообщение.
starMessages(messages) GmailApp Добавляет звездочки к этим сообщениям и принудительно обновляет сообщения.
unstarMessage(message) GmailApp Удаляет звездочку из этого сообщения и принудительно обновляет сообщение.
unstarMessages(messages) GmailApp Удаляет звездочки из этих сообщений и принудительно обновляет сообщения.

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

createDraft(recipient, subject, body)

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

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

Параметры

Имя Тип Описание
recipient String список адресов электронной почты, разделенный запятыми
subject String тема письма
body String тело электронного письма

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

GmailDraft — недавно созданный GmailDraft.

Авторизация

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

  • https://mail.google.com/

См. также

createDraft(recipient, subject, body, options)

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

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Параметры

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

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

Имя Тип Описание
attachments BlobSource[] массив файлов для отправки по электронной почте
bcc String список адресов электронной почты, разделенных запятыми, для BCC
cc String список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых getAliases()
htmlBody String если установлено, устройства, способные отображать HTML, будут использовать его вместо обязательного аргумента тела; вы можете добавить дополнительное поле inlineImages в тело HTML, если у вас есть встроенные изображения для вашей электронной почты.
inlineImages Object объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( BlobSource ); при этом предполагается, что используется параметр htmlBody и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String имя отправителя электронного письма (по умолчанию: имя пользователя)
replyTo String адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя)

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

GmailDraft — недавно созданный GmailDraft.

Авторизация

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

  • https://mail.google.com/

См. также

createLabel(name)

Создайте новую метку пользователя с данным именем.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

Параметры

Имя Тип Описание
name String название нового лейбла

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

GmailLabel — новый ярлык.

Авторизация

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

  • https://mail.google.com/

См. также

deleteLabel(label)

Удаляет указанную метку.

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

Параметры

Имя Тип Описание
label GmailLabel ярлык, который нужно удалить

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

getAliases()

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

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

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

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

String[] — массив псевдонимов для этого аккаунта

Авторизация

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

  • https://mail.google.com/

См. также

getDraft(draftId)

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

Используйте это вместе с getId() в черновиках Gmail.

// Get the first draft message in your drafts folder
var draft = GmailApp.getDrafts()[0];
// Get its ID
var draftId = draft.getId();
// Now fetch the same draft using that ID.
var draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

Параметры

Имя Тип Описание
draftId String идентификатор черновика, который нужно получить

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

GmailDraft — черновик с заданным идентификатором

Броски

Error — если не найден черновик с данным идентификатором.

Авторизация

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

  • https://mail.google.com/

getDraftMessages()

Извлекает все черновики сообщений.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

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

GmailMessage[] — массив черновиков сообщений Gmail.

Авторизация

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

  • https://mail.google.com/

getDrafts()

Получает все черновики сообщений Gmail.

var drafts = GmailApp.getDrafts();
for (var i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

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

GmailDraft[] — массив черновиков сообщений Gmail.

Авторизация

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

  • https://mail.google.com/

getInboxThreads()

Извлекает все ветки папки «Входящие» независимо от меток.

Этот вызов завершится неудачно, если размер всех потоков слишком велик для системы. Если размер потока неизвестен и потенциально очень велик, используйте вызов «paged» и укажите диапазоны потоков, которые будут извлекаться при каждом вызове.

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

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

GmailThread[] — массив цепочек Gmail в папке «Входящие».

Авторизация

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

  • https://mail.google.com/

getInboxThreads(start, max)

Извлекает диапазон веток папки «Входящие» независимо от меток. 

// Log the subject lines of up to the first 50 emails in your Inbox
var threads = GmailApp.getInboxThreads(0, 50);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Параметры

Имя Тип Описание
start Integer индекс первого потока для получения
max Integer максимальное количество потоков для получения

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

GmailThread[] — массив веток Gmail в папке «Входящие».

Авторизация

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

  • https://mail.google.com/

getInboxUnreadCount()

Получает количество непрочитанных цепочек в папке «Входящие». 

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

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

Integer — количество тредов во входящих, в которых есть непрочитанные сообщения.

Авторизация

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

  • https://mail.google.com/

getMessageById(id)

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

Используйте это вместе с getId() в сообщениях Gmail. 

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

Параметры

Имя Тип Описание
id String идентификатор сообщения, которое нужно получить

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

GmailMessage — сообщение с заданным идентификатором

Броски

Error — если сообщение с данным идентификатором не найдено.

Авторизация

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

  • https://mail.google.com/

См. также

getMessagesForThread(thread)

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

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

Параметры

Имя Тип Описание
thread GmailThread поток сообщений для получения

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

GmailMessage[] — массив сообщений, соответствующих этой теме

Авторизация

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

  • https://mail.google.com/

См. также

getMessagesForThreads(threads)

Получить все сообщения в указанных потоках. 

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

Параметры

Имя Тип Описание
threads GmailThread[] потоки сообщений для получения

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

GmailMessage[][] — массив массивов сообщений, где каждый элемент внешнего массива соответствует потоку, а внутренний массив содержит сообщения в этом потоке.

Авторизация

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

  • https://mail.google.com/

См. также

getPriorityInboxThreads()

Извлекает все цепочки приоритетных входящих независимо от меток.

Этот вызов завершится неудачно, если размер всех потоков слишком велик для системы. Если размер потока неизвестен и потенциально очень велик, используйте вызов «paged» и укажите диапазоны потоков, которые будут извлекаться при каждом вызове. 

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

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

GmailThread[] — массив цепочек Gmail в папке «Приоритетные входящие».

Авторизация

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

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

Извлекает ряд цепочек приоритетных входящих независимо от меток. 

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

Параметры

Имя Тип Описание
start Integer индекс первого потока для получения
max Integer максимальное количество потоков для получения

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

GmailThread[] — массив цепочек Gmail в папке «Приоритетные входящие».

Авторизация

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

  • https://mail.google.com/

getPriorityInboxUnreadCount()

Получает количество непрочитанных цепочек в папке «Приоритетные входящие». 

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

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

Integer — количество цепочек в папке «Приоритетные входящие», в которых есть непрочитанные сообщения.

Авторизация

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

  • https://mail.google.com/

getSpamThreads()

Извлекает все спам-темы независимо от меток.

Этот вызов завершится неудачно, если размер всех потоков слишком велик для системы. Если размер потока неизвестен и потенциально очень велик, используйте вызов «paged» и укажите диапазоны потоков, которые будут извлекаться при каждом вызове. 

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

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

GmailThread[] — массив тредов Gmail в папке со спамом.

Авторизация

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

  • https://mail.google.com/

getSpamThreads(start, max)

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

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

Параметры

Имя Тип Описание
start Integer индекс первого потока для получения
max Integer максимальное количество потоков для получения

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

GmailThread[] — массив тредов Gmail в папке со спамом.

Авторизация

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

  • https://mail.google.com/

getSpamUnreadCount()

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

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

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

Integer — количество спам-тем, в которых есть непрочитанные сообщения.

Авторизация

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

  • https://mail.google.com/

getStarredThreads()

Извлекает все помеченные темы независимо от меток.

Этот вызов завершится неудачно, если размер всех потоков слишком велик для системы. Если размер потока неизвестен и потенциально очень велик, используйте вызов «paged» и укажите диапазоны потоков, которые будут извлекаться при каждом вызове. 

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

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

GmailThread[] — массив помеченных тем Gmail.

Авторизация

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

  • https://mail.google.com/

getStarredThreads(start, max)

Извлекает диапазон отмеченных тем независимо от меток. 

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

Параметры

Имя Тип Описание
start Integer индекс первого потока для получения
max Integer максимальное количество потоков для получения

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

GmailThread[] — массив помеченных тем Gmail.

Авторизация

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

  • https://mail.google.com/

getStarredUnreadCount()

Получает количество помеченных непрочитанных тем. 

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

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

Integer — количество отмеченных тем с непрочитанными сообщениями.

Авторизация

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

  • https://mail.google.com/

getThreadById(id)

Получает поток по идентификатору.

Используйте это вместе с getId() в цепочках Gmail. 

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0,1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());

Параметры

Имя Тип Описание
id String Идентификатор потока, который требуется получить.

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

GmailThread — поток с заданным идентификатором или null , если не найден.

Авторизация

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

  • https://mail.google.com/

См. также

getTrashThreads()

Извлекает все мусорные темы независимо от меток.

Этот вызов завершится неудачно, если размер всех потоков слишком велик для системы. Если размер потока неизвестен и потенциально очень велик, используйте вызов «paged» и укажите диапазоны потоков, которые будут извлекаться при каждом вызове. 

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

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

GmailThread[] — массив тредов Gmail в корзине.

Авторизация

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

  • https://mail.google.com/

getTrashThreads(start, max)

Извлекает ряд мусорных потоков независимо от меток. 

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

Параметры

Имя Тип Описание
start Integer индекс первого потока для получения
max Integer максимальное количество потоков для получения

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

GmailThread[] — массив тредов Gmail в корзине.

Авторизация

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

  • https://mail.google.com/

getUserLabelByName(name)

Получает метку по ее имени. 

var labelObject = GmailApp.getUserLabelByName("myLabel");

Параметры

Имя Тип Описание
name String имя метки, которую нужно получить

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

GmailLabel — ярлык Gmail с заданным именем.

Авторизация

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

  • https://mail.google.com/

getUserLabels()

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

// Logs all of the names of your labels
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

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

GmailLabel[] — массив созданных пользователем ярлыков

Авторизация

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

  • https://mail.google.com/

markMessageRead(message)

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

// Mark the first message in the first thread of your inbox as read
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Параметры

Имя Тип Описание
message GmailMessage сообщение, которое нужно пометить как прочитанное

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markMessageUnread(message)

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

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Параметры

Имя Тип Описание
message GmailMessage сообщение, которое следует пометить как непрочитанное

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markMessagesRead(messages)

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

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

Параметры

Имя Тип Описание
messages GmailMessage[] массив сообщений, которые нужно пометить как прочитанные

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markMessagesUnread(messages)

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

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

Параметры

Имя Тип Описание
messages GmailMessage[] массив сообщений, которые можно пометить как непрочитанные

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markThreadImportant(thread)

Отмечает эту тему как важную и принудительно обновляет ее. 

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Параметры

Имя Тип Описание
thread GmailThread тему, которую нужно отметить как важную

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markThreadRead(thread)

Помечает эту тему как прочитанную и принудительно обновляет ее. 

// Marks first inbox thread as read
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Параметры

Имя Тип Описание
thread GmailThread тему пометить как прочитанную

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markThreadUnimportant(thread)

Помечает этот поток как неважный и принудительно обновляет поток. 

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Параметры

Имя Тип Описание
thread GmailThread тему, которую нужно отметить как неважную

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markThreadUnread(thread)

Помечает эту тему как непрочитанную и принудительно обновляет ее. 

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Параметры

Имя Тип Описание
thread GmailThread тему, которую нужно пометить как непрочитанную

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markThreadsImportant(threads)

Помечает эти темы как важные и принудительно обновляет их. 

// Marks first two threads in inbox as important
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Параметры

Имя Тип Описание
threads GmailThread[] массив тем, которые можно отметить как важные

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markThreadsRead(threads)

Помечает эти потоки как прочитанные и принудительно обновляет потоки. 

// Marks first two threads in inbox as read
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Параметры

Имя Тип Описание
threads GmailThread[] массив потоков, которые нужно пометить как прочитанные

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markThreadsUnimportant(threads)

Помечает эти потоки как неважные и принудительно обновляет потоки. 

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Параметры

Имя Тип Описание
threads GmailThread[] массив потоков, которые можно пометить как неважные

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

markThreadsUnread(threads)

Помечает эти темы как непрочитанные и принудительно обновляет их. 

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Параметры

Имя Тип Описание
threads GmailThread[] массив потоков, которые можно пометить как непрочитанные

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

moveMessageToTrash(message)

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

// Move the first message in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Параметры

Имя Тип Описание
message GmailMessage сообщение, которое нужно удалить

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

GmailApp — служба Gmail (полезна для создания цепочки)

Авторизация

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

  • https://mail.google.com/

См. также

moveMessagesToTrash(messages)

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

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Параметры

Имя Тип Описание
messages GmailMessage[] сообщения, которые нужно удалить

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

GmailApp — служба Gmail (полезна для создания цепочки)

Авторизация

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

  • https://mail.google.com/

См. также

moveThreadToArchive(thread)

Перемещает этот поток в архив и принудительно обновляет поток. 

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

Параметры

Имя Тип Описание
thread GmailThread тема для архивирования

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

moveThreadToInbox(thread)

Перемещает эту цепочку в папку «Входящие» и принудительно ее обновляет. 

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

Параметры

Имя Тип Описание
thread GmailThread ветка, которую нужно переместить во входящие

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

moveThreadToSpam(thread)

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

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

Параметры

Имя Тип Описание
thread GmailThread тему перенести в спам

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

moveThreadToTrash(thread)

Перемещает эту тему в корзину и принудительно обновляет ее. 

// Move first thread in inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToTrash(firstThread);

Параметры

Имя Тип Описание
thread GmailThread ветка, которую нужно выбросить

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

moveThreadsToArchive(threads)

Перемещает эти потоки в архив и принудительно обновляет потоки. 

// Move first two threads in your inbox to the archive
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Параметры

Имя Тип Описание
threads GmailThread[] массив потоков для архивирования

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

moveThreadsToInbox(threads)

Перемещает эти темы во входящие и принудительно обновляет их. 

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Параметры

Имя Тип Описание
threads GmailThread[] массив тем, которые нужно переместить во входящие

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

moveThreadsToSpam(threads)

Перемещает эти темы в спам и принудительно обновляет их. 

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Параметры

Имя Тип Описание
threads GmailThread[] массив тем, которые будут отправлены в спам

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

moveThreadsToTrash(threads)

Перемещает эти потоки в корзину и принудительно обновляет потоки. 

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Параметры

Имя Тип Описание
threads GmailThread[] массив потоков, которые нужно удалить

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

refreshMessage(message)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

Параметры

Имя Тип Описание
message GmailMessage сообщение, которое нужно обновить

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

refreshMessages(messages)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

Параметры

Имя Тип Описание
messages GmailMessage[] сообщения, которые необходимо обновить

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

refreshThread(thread)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Параметры

Имя Тип Описание
thread GmailThread ветка, которую нужно обновить

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

refreshThreads(threads)

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

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Параметры

Имя Тип Описание
threads GmailThread[] темы, которые нужно обновить

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

search(query)

Найдите Gmail по заданному запросу.

Этот вызов завершится неудачно, если размер всех потоков слишком велик для системы. Если размер потока неизвестен и потенциально очень велик, используйте вызов «paged» и укажите диапазоны потоков, которые будут извлекаться при каждом вызове. 

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Параметры

Имя Тип Описание
query String поисковый запрос, как если бы вы вводили его в Gmail

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

GmailThread[] — массив тредов Gmail, соответствующих этому запросу.

Авторизация

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

  • https://mail.google.com/

search(query, start, max)

Найдите Gmail по заданному запросу. 

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Параметры

Имя Тип Описание
query String поисковый запрос, как если бы вы вводили его в Gmail
start Integer индекс стартового потока
max Integer максимальное количество потоков для возврата

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

GmailThread[] — массив тредов Gmail, соответствующих этому запросу.

Авторизация

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

  • https://mail.google.com/

sendEmail(recipient, subject, body)

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

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

Параметры

Имя Тип Описание
recipient String список адресов электронной почты, разделенный запятыми
subject String тема письма (максимум 250 символов)
body String тело электронного письма

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

sendEmail(recipient, subject, body, options)

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

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Параметры

Имя Тип Описание
recipient String адреса получателя
subject String тема письма (максимум 250 символов)
body String тело электронного письма
options Object объект JavaScript, который определяет дополнительные параметры, как указано ниже

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

Имя Тип Описание
attachments BlobSource[] массив файлов для отправки по электронной почте
bcc String список адресов электронной почты, разделенных запятыми, для BCC
cc String список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых getAliases()
htmlBody String если установлено, устройства, способные отображать HTML, будут использовать его вместо обязательного аргумента тела; вы можете добавить дополнительное поле inlineImages в тело HTML, если у вас есть встроенные изображения для вашей электронной почты.
inlineImages Object объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( BlobSource ); при этом предполагается, что используется параметр htmlBody и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String имя отправителя электронного письма (по умолчанию: имя пользователя)
noReply Boolean true , если электронное письмо должно быть отправлено с общего адреса электронной почты, на который нет ответа, чтобы получатели не отвечали на электронные письма; этот вариант возможен только для учетных записей Google Workspace, но не для пользователей Gmail.
replyTo String адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя)

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

setCurrentMessageAccessToken(accessToken)

Устанавливает токен доступа к текущему сообщению , который позволяет сценарию получать доступ к текущим свойствам GmailMessage .

Этот метод требуется только для проектов надстроек Google Workspace, использующих области текущих сообщений Gmail. 

function handleAddonActionEvent(e) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

Параметры

Имя Тип Описание
accessToken String токен временного доступа, полученный из объекта события действия надстройки Gmail.

Авторизация

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

  • https://mail.google.com/

starMessage(message)

Добавляет звездочку к этому сообщению и принудительно обновляет сообщение. 

// Stars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Параметры

Имя Тип Описание
message GmailMessage сообщение, которое нужно отметить

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

starMessages(messages)

Добавляет звездочки к этим сообщениям и принудительно обновляет сообщения. 

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Параметры

Имя Тип Описание
messages GmailMessage[] массив сообщений для звездочки

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

unstarMessage(message)

Удаляет звездочку из этого сообщения и принудительно обновляет сообщение. 

// Unstars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Параметры

Имя Тип Описание
message GmailMessage сообщение, которое нужно снять с отметки

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

unstarMessages(messages)

Удаляет звездочки из этих сообщений и принудительно обновляет сообщения. 

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Параметры

Имя Тип Описание
messages GmailMessage[] массив сообщений, которые нужно снять с отметки

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

GmailApp — сервис Gmail, полезный для создания цепочек

Авторизация

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

  • https://mail.google.com/

См. также

Устаревшие методы