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