Class GmailLabel

Ярлык Gmail

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

Методы

Метод Тип возврата Краткое описание
add To Thread(thread) Gmail Label Добавляет эту метку в заданный поток и принудительно обновляет поток ( Gmail Thread.refresh() ).
add To Threads(threads) Gmail Label Добавляет эту метку к заданным потокам и принудительно обновляет потоки.
delete Label() void Удаляет этот ярлык.
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 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/

См. также