Class GmailLabel

Ярлык Gmail

Ярлык, созданный пользователем в его учетной записи Gmail.

Методы

Метод Тип возврата Краткое описание
add To Thread(thread) Gmail Label Добавляет эту метку к указанному потоку и принудительно обновляет поток ( Gmail Thread.refresh() ).
add To Threads(threads) Gmail Label Добавляет эту метку к указанным потокам и принудительно обновляет потоки.
delete Label() void Удаляет эту метку.
get Id() String Получает идентификатор этой метки.
get Name() String Получает имя этой метки.
get Threads() Gmail Thread[] Получает потоки, отмеченные этой меткой.
get Threads(start, max) Gmail Thread[] Получает ряд потоков, отмеченных этой меткой.
get Unread Count() Integer Возвращает количество непрочитанных сообщений, отмеченных этой меткой.
remove From Thread(thread) Gmail Label Удаляет эту метку из указанного потока и принудительно обновляет поток.
remove From Threads(threads) Gmail Label Удаляет эту метку из указанных потоков и принудительно обновляет потоки.

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

add To Thread(thread)

Добавляет эту метку к указанному потоку и принудительно обновляет поток ( Gmail Thread.refresh() ).

// label the first thread in the inbox with the label MyLabel const label = GmailApp.getUserLabelByName('MyLabel'); const firstThread = GmailApp.getInboxThreads(0, 1)[0]; label.addToThread(firstThread);

Параметры

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

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

Gmail Label — этот ярлык предназначен для объединения в цепочку.

Авторизация

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

  • https://mail.google.com/

Смотрите также


add To Threads(threads)

Добавляет эту метку к указанным потокам и принудительно обновляет их. Вы можете добавить метки максимум для 100 потоков в одном пакете.

// label the first three threads in the inbox with the label MyLabel const label = GmailApp.getUserLabelByName('MyLabel'); const threads = GmailApp.getInboxThreads(0, 3); label.addToThreads(threads);

Параметры

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

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

Gmail Label — этот ярлык предназначен для объединения в цепочку.

Авторизация

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

  • https://mail.google.com/

Смотрите также


delete Label()

Удаляет эту метку.

const label = GmailApp.getUserLabelByName('MyLabel'); label.deleteLabel();

Броски

Error — если метку невозможно удалить

Авторизация

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

  • https://mail.google.com/

Смотрите также


get Id()

Получает идентификатор этой метки.

const label = GmailApp.getUserLabelByName('MyLabel'); console.log(label.getId());

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

String — идентификатор метки.

Авторизация

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

  • https://mail.google.com/

get Name()

Получает имя этой метки.

const label = GmailApp.getUserLabelByName('MyLabel'); Logger.log(label.getName());  // logs MyLabel

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

String — Имя метки.

Авторизация

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

  • https://mail.google.com/

get Threads()

Получает потоки, отмеченные этой меткой.

Эти вызовы завершаются ошибкой, если размер всех потоков слишком велик для обработки системой. Если размер потока неизвестен и потенциально очень велик, используйте get Threads(start, max) и укажите диапазоны потоков для извлечения в каждом вызове.

// Log the subject lines of the threads labeled with MyLabel const label = GmailApp.getUserLabelByName('MyLabel'); const threads = label.getThreads(); for (let i = 0; i < threads.length; i++) {   Logger.log(threads[i].getFirstMessageSubject()); }

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

Gmail Thread[] — Массив веток, отмеченных этой меткой.

Авторизация

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

  • https://mail.google.com/

get Threads(start, max)

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

// log the subject lines of up to the first 30 threads with the label MyLabel const label = GmailApp.getUserLabelByName('MyLabel'); const threads = label.getThreads(0, 30); for (let i = 0; i < threads.length; i++) {   Logger.log(threads[i].getFirstMessageSubject()); }

Параметры

Имя Тип Описание
start Integer Индекс исходной ветки.
max Integer Максимальное количество возвращаемых потоков.

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

Gmail Thread[] — Массив веток, отмеченных этой меткой.

Авторизация

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

  • https://mail.google.com/

get Unread Count()

Возвращает количество непрочитанных сообщений, отмеченных этой меткой.

// log the number of unread threads labeled with MyLabel const label = GmailApp.getUserLabelByName('MyLabel'); Logger.log(label.getUnreadCount());

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

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

Авторизация

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

  • https://mail.google.com/

remove From Thread(thread)

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

// remove the label MyLabel from the first thread in the inbox const label = GmailApp.getUserLabelByName('MyLabel'); const firstThread = GmailApp.getInboxThreads(0, 1)[0]; label.removeFromThread(firstThread);

Параметры

Имя Тип Описание
thread Gmail Thread Тема будет без маркировки.

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

Gmail Label — этот ярлык предназначен для объединения в цепочку.

Авторизация

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

  • https://mail.google.com/

Смотрите также


remove From Threads(threads)

Удаляет метку с указанных потоков и принудительно обновляет их. Вы можете удалить метки максимум с 100 потоков за один пакет.

// remove the label MyLabel from the first three threads in the inbox const label = GmailApp.getUserLabelByName('MyLabel'); const threads = GmailApp.getInboxThreads(0, 3); label.removeFromThreads(threads);

Параметры

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

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

Gmail Label — этот ярлык предназначен для объединения в цепочку.

Авторизация

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

  • https://mail.google.com/

Смотрите также