Созданная пользователем метка в учетной записи Gmail пользователя.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addToThread(thread) | GmailLabel | Добавляет эту метку в данный поток и принудительно обновляет поток ( GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | Добавляет эту метку к заданным потокам и принудительно обновляет потоки. |
deleteLabel() | void | Удаляет этот ярлык. |
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 var label = GmailApp.getUserLabelByName("MyLabel"); var 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 var label = GmailApp.getUserLabelByName("MyLabel"); var threads = GmailApp.getInboxThreads(0,3); label.addToThreads(threads);
Параметры
Имя | Тип | Описание |
---|---|---|
threads | GmailThread[] | Массив потоков, которые нужно пометить. |
Возвращаться
GmailLabel
— эта метка для связывания.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/
См. также
deleteLabel()
Удаляет этот ярлык.
var label = GmailApp.getUserLabelByName("MyLabel"); label.deleteLabel();
Броски
Error
— если метку невозможно удалить.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/
См. также
getName()
Получает имя этой метки.
var 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 var label = GmailApp.getUserLabelByName("MyLabel"); var threads = label.getThreads(); for (var 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 var label = GmailApp.getUserLabelByName("MyLabel"); var threads = label.getThreads(0, 30); for (var 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 var 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 var label = GmailApp.getUserLabelByName("MyLabel"); var 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 var label = GmailApp.getUserLabelByName("MyLabel"); var threads = GmailApp.getInboxThreads(0,3); label.removeFromThreads(threads);
Параметры
Имя | Тип | Описание |
---|---|---|
threads | GmailThread[] | Массив потоков, которые не должны быть помечены. |
Возвращаться
GmailLabel
— эта метка для связывания.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/