Class GmailLabel

GmailLabel

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

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

addToThread(thread)

Добавляет эту метку к указанной ветке обсуждения и принудительно обновляет её ( GmailThread.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 Нить, которую необходимо обозначить.

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

GmailLabel — Эта метка предназначена для создания цепочек писем.

Авторизация

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

  • https://mail.google.com/

См. также


addToThreads(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[] Массив потоков, которые необходимо пометить.

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

GmailLabel — Эта метка предназначена для создания цепочек писем.

Авторизация

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

  • https://mail.google.com/

См. также


deleteLabel()

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

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

Броски

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

Авторизация

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

  • https://mail.google.com/

См. также


getId()

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

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

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

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

Авторизация

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

  • https://mail.google.com/

getName()

Получает название этой этикетки.

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

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

String — Название метки.

Авторизация

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

  • https://mail.google.com/

getThreads()

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

Эти вызовы завершаются ошибкой, если размер всех потоков слишком велик для обработки системой. Если размер потоков неизвестен и потенциально очень велик, используйте getThreads(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());
}

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

GmailThread[] — Массив веток обсуждений, помеченных этой меткой.

Авторизация

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

  • https://mail.google.com/

getThreads(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 Максимальное количество потоков для возврата.

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

GmailThread[] — Массив веток обсуждений, помеченных этой меткой.

Авторизация

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

  • https://mail.google.com/

getUnreadCount()

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

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

removeFromThread(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 Тема обсуждения может быть без подписи.

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

GmailLabel — Эта метка предназначена для создания цепочек писем.

Авторизация

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

  • https://mail.google.com/

См. также


removeFromThreads(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[] Массив потоков, которые не будут помечены.

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

GmailLabel — Эта метка предназначена для создания цепочек писем.

Авторизация

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

  • https://mail.google.com/

См. также