Class GmailApp

Приложение Gmail

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

Методы

Метод Тип возврата Краткое описание
create Draft(recipient, subject, body) Gmail Draft Создает черновик сообщения электронной почты.
create Draft(recipient, subject, body, options) Gmail Draft Создает черновик сообщения электронной почты с необязательными аргументами.
create Label(name) Gmail Label Создайте новую метку пользователя с данным именем.
delete Label(label) Gmail App Удаляет указанную метку.
get Aliases() String[] Получает список адресов электронной почты, настроенных в качестве псевдонимов для этой учетной записи в Gmail.
get Draft(draftId) Gmail Draft Получить черновик сообщения электронной почты по идентификатору.
get Draft Messages() Gmail Message[] Извлекает все черновики сообщений.
get Drafts() Gmail Draft[] Получает все черновики сообщений Gmail.
get Inbox Threads() Gmail Thread[] Извлекает все ветки папки «Входящие» независимо от меток.
get Inbox Threads(start, max) Gmail Thread[] Извлекает диапазон веток папки «Входящие» независимо от меток.
get Inbox Unread Count() Integer Получает количество непрочитанных цепочек в папке «Входящие».
get Message By Id(id) Gmail Message Получает сообщение по идентификатору.
get Messages For Thread(thread) Gmail Message[] Получить все сообщения в указанном потоке.
get Messages For Threads(threads) Gmail Message[][] Получить все сообщения в указанных потоках.
get Priority Inbox Threads() Gmail Thread[] Извлекает все цепочки приоритетных входящих независимо от меток.
get Priority Inbox Threads(start, max) Gmail Thread[] Извлекает ряд цепочек приоритетных входящих независимо от меток.
get Priority Inbox Unread Count() Integer Получает количество непрочитанных цепочек в папке «Приоритетные входящие».
get Spam Threads() Gmail Thread[] Извлекает все спам-темы независимо от меток.
get Spam Threads(start, max) Gmail Thread[] Извлекает ряд спам-сообщений независимо от меток.
get Spam Unread Count() Integer Получает количество непрочитанных тем, являющихся спамом.
get Starred Threads() Gmail Thread[] Извлекает все помеченные темы независимо от меток.
get Starred Threads(start, max) Gmail Thread[] Извлекает диапазон отмеченных тем независимо от меток.
get Starred Unread Count() Integer Получает количество помеченных непрочитанных тем.
get Thread By Id(id) Gmail Thread Получает поток по идентификатору.
get Trash Threads() Gmail Thread[] Извлекает все мусорные темы независимо от меток.
get Trash Threads(start, max) Gmail Thread[] Извлекает ряд мусорных потоков независимо от меток.
get User Label By Name(name) Gmail Label Получает метку по ее имени.
get User Labels() Gmail Label[] Получает список меток, созданных пользователем.
mark Message Read(message) Gmail App Отмечает это сообщение как прочитанное и принудительно обновляет его.
mark Message Unread(message) Gmail App Помечает это сообщение как непрочитанное и принудительно обновляет сообщение.
mark Messages Read(messages) Gmail App Отмечает эти сообщения как прочитанные и принудительно обновляет сообщения.
mark Messages Unread(messages) Gmail App Помечает эти сообщения как непрочитанные и принудительно обновляет сообщения.
mark Thread Important(thread) Gmail App Отмечает эту тему как важную и принудительно обновляет ее.
mark Thread Read(thread) Gmail App Помечает эту тему как прочитанную и принудительно обновляет ее.
mark Thread Unimportant(thread) Gmail App Помечает этот поток как неважный и принудительно обновляет поток.
mark Thread Unread(thread) Gmail App Помечает эту тему как непрочитанную и принудительно обновляет ее.
mark Threads Important(threads) Gmail App Помечает эти темы как важные и принудительно обновляет их.
mark Threads Read(threads) Gmail App Помечает эти потоки как прочитанные и принудительно обновляет потоки.
mark Threads Unimportant(threads) Gmail App Помечает эти потоки как неважные и принудительно обновляет их.
mark Threads Unread(threads) Gmail App Помечает эти темы как непрочитанные и принудительно обновляет их.
move Message To Trash(message) Gmail App Перемещает сообщение в корзину и принудительно обновляет сообщение.
move Messages To Trash(messages) Gmail App Перемещает указанные сообщения в корзину и принудительно обновляет сообщения.
move Thread To Archive(thread) Gmail App Перемещает этот поток в архив и принудительно обновляет поток.
move Thread To Inbox(thread) Gmail App Перемещает эту цепочку в папку «Входящие» и принудительно ее обновляет.
move Thread To Spam(thread) Gmail App Перемещает эту тему в спам и принудительно обновляет ее.
move Thread To Trash(thread) Gmail App Перемещает эту тему в корзину и принудительно обновляет ее.
move Threads To Archive(threads) Gmail App Перемещает эти потоки в архив и принудительно обновляет потоки.
move Threads To Inbox(threads) Gmail App Перемещает эти темы во входящие и принудительно обновляет их.
move Threads To Spam(threads) Gmail App Перемещает эти темы в спам и принудительно обновляет их.
move Threads To Trash(threads) Gmail App Перемещает эти потоки в корзину и принудительно обновляет потоки.
refresh Message(message) Gmail App Перезагружает сообщение и связанное с ним состояние из Gmail (полезно, если изменились метки, состояние чтения и т. д.).
refresh Messages(messages) Gmail App Перезагружает сообщения и связанное с ними состояние из Gmail (полезно, если изменились метки, состояние чтения и т. д.).
refresh Thread(thread) Gmail App Перезагружает цепочку и связанное с ней состояние из Gmail (полезно, если изменились метки, состояние чтения и т. д.).
refresh Threads(threads) Gmail App Перезагружает потоки и связанное с ними состояние из Gmail (полезно, если изменились метки, состояние чтения и т. д.).
search(query) Gmail Thread[] Найдите Gmail по заданному запросу.
search(query, start, max) Gmail Thread[] Найдите Gmail по заданному запросу.
send Email(recipient, subject, body) Gmail App Отправляет сообщение электронной почты.
send Email(recipient, subject, body, options) Gmail App Отправляет сообщение электронной почты с необязательными аргументами.
set Current Message Access Token(accessToken) void Устанавливает токен доступа к текущему сообщению , который позволяет сценарию получать доступ к текущим свойствам Gmail Message .
star Message(message) Gmail App Добавляет звездочку к этому сообщению и принудительно обновляет сообщение.
star Messages(messages) Gmail App Добавляет звездочки к этим сообщениям и принудительно обновляет сообщения.
unstar Message(message) Gmail App Удаляет звездочку из этого сообщения и принудительно обновляет сообщение.
unstar Messages(messages) Gmail App Удаляет звездочки из этих сообщений и принудительно обновляет сообщения.

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

create Draft(recipient, subject, body)

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

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

См. также

create Draft(recipient, subject, body, options)

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

// Create a draft email with a file from Google Drive attached as a PDF.
const 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 Blob Source[] массив файлов для отправки по электронной почте
bcc String список адресов электронной почты, разделенных запятыми, для BCC
cc String список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых функцией get Aliases()
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 адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя)

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

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

Авторизация

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

  • https://mail.google.com/

См. также

create Label(name)

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

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Параметры

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

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

Gmail Label — недавно созданный ярлык.

Авторизация

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

  • https://mail.google.com/

См. также

delete Label(label)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

get Aliases()

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

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

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const 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/

См. также

get Draft(draftId)

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

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

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

Параметры

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

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

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

Броски

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

Авторизация

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

  • https://mail.google.com/

get Draft Messages()

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

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

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

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

Авторизация

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

  • https://mail.google.com/

get Drafts()

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

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

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

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

Авторизация

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

  • https://mail.google.com/

get Inbox Threads()

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

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

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

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

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

Авторизация

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

  • https://mail.google.com/

get Inbox Threads(start, max)

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

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

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

get Inbox Unread Count()

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

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

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

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

Авторизация

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

  • https://mail.google.com/

get Message By Id(id)

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

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

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

Параметры

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

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

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

Броски

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

Авторизация

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

  • https://mail.google.com/

См. также

get Messages For Thread(thread)

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

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

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

См. также

get Messages For Threads(threads)

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

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

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

См. также

get Priority Inbox Threads()

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

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

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

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

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

Авторизация

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

  • https://mail.google.com/

get Priority Inbox Threads(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 максимальное количество потоков для получения

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

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

Авторизация

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

  • https://mail.google.com/

get Priority Inbox Unread Count()

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

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

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

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

Авторизация

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

  • https://mail.google.com/

get Spam Threads()

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

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

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

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

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

Авторизация

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

  • https://mail.google.com/

get Spam Threads(start, max)

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

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

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

get Spam Unread Count()

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

// 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/

get Starred Threads()

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

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

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

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

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

Авторизация

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

  • https://mail.google.com/

get Starred Threads(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 максимальное количество потоков для получения

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

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

Авторизация

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

  • https://mail.google.com/

get Starred Unread Count()

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

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

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

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

Авторизация

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

  • https://mail.google.com/

get Thread By Id(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 Идентификатор потока, который требуется получить.

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

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

Авторизация

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

  • https://mail.google.com/

См. также

get Trash Threads()

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

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

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

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

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

Авторизация

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

  • https://mail.google.com/

get Trash Threads(start, max)

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

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

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

get User Label By Name(name)

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

const labelObject = GmailApp.getUserLabelByName('myLabel');

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

get User Labels()

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

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

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

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

Авторизация

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

  • https://mail.google.com/

mark Message Read(message)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Message Unread(message)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Messages Read(messages)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Messages Unread(messages)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочек сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Thread Important(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Thread Read(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Thread Unimportant(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Thread Unread(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочек сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Threads Important(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Threads Read(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Threads Unimportant(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

mark Threads Unread(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

move Message To Trash(message)

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

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

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

См. также

move Messages To Trash(messages)

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

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

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

См. также

move Thread To Archive(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

move Thread To Inbox(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

move Thread To Spam(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

move Thread To Trash(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

move Threads To Archive(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

move Threads To Inbox(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

move Threads To Spam(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

move Threads To Trash(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочек сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

refresh Message(message)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

refresh Messages(messages)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

refresh Thread(thread)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

refresh Threads(threads)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочек сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

search(query)

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

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

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

Параметры

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

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

Gmail Thread[] — массив тредов 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.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Параметры

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

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

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

Авторизация

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

  • https://mail.google.com/

send Email(recipient, subject, body)

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

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

send Email(recipient, subject, body, options)

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

// Send an email with a file from Google Drive attached as a PDF.
const 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 Blob Source[] массив файлов для отправки по электронной почте
bcc String список адресов электронной почты, разделенных запятыми, для BCC
cc String список адресов электронной почты, разделенных запятыми, для CC
from String адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых функцией get Aliases()
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 адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя)

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

Gmail App — служба Gmail, полезная для создания цепочки сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

set Current Message Access Token(accessToken)

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

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

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

Параметры

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

Авторизация

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

  • https://mail.google.com/

star Message(message)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочек сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

star Messages(messages)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочек сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

unstar Message(message)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочек сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

unstar Messages(messages)

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

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

Параметры

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

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

Gmail App — служба Gmail, полезная для создания цепочек сообщений.

Авторизация

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

  • https://mail.google.com/

См. также

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