Class GmailLabel

GmailLabel

Созданный пользователем ярлык в его аккаунте Gmail.

Методы

Метод Тип возврата Краткое описание
addToThread(thread) GmailLabel Добавляет эту метку к указанной ветке и принудительно обновляет ветку ( GmailThread.refresh() ).
addToThreads(threads) GmailLabel Добавляет эту метку к указанным потокам и принудительно обновляет потоки.
deleteLabel() void Удаляет эту метку.
getId() String Получает идентификатор этой метки.
getName() String Получает имя этой метки.
getThreads() GmailThread[] Получает потоки, отмеченные этой меткой.
getThreads(start, max) GmailThread[] Получает ряд потоков, отмеченных этим ярлыком.
getUnreadCount() Integer Получает количество непрочитанных тем, помеченных этой меткой.
removeFromThread(thread) GmailLabel Удаляет эту метку из указанного потока и принудительно обновляет поток.
removeFromThreads(threads) GmailLabel Удаляет эту метку из указанных потоков и принудительно обновляет потоки.

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

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 GmailThread Нить, которую необходимо пометить.

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

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

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

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 GmailThread Тема не должна иметь метки.

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

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

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

GmailLabel — этот ярлык для цепочки.

Авторизация

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

  • https://mail.google.com/

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