Gmail Service

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Gmail

Эта служба позволяет отправлять электронную почту, создавать черновики, управлять ярлыками, отмечать сообщения и цепочки, а также выполнять множество других задач по управлению учетной записью Gmail. См. также Почтовая служба , более простая служба, которая позволяет только отправлять электронную почту.

Классы

Имя Краткое описание
GmailApp Предоставляет доступ к цепочкам, сообщениям и ярлыкам Gmail.
GmailAttachment Вложение из Gmail.
GmailDraft Созданный пользователем черновик сообщения в учетной записи пользователя Gmail.
GmailLabel Созданный пользователем ярлык в учетной записи Gmail пользователя.
GmailMessage Сообщение в учетной записи Gmail пользователя.
GmailThread Тема в учетной записи Gmail пользователя.

GmailApp

Методы

Метод Тип возврата Краткое описание
createDraft(recipient, subject, body) GmailDraft Создает черновик сообщения электронной почты.
createDraft(recipient, subject, body, options) GmailDraft Создает черновик сообщения электронной почты с необязательными аргументами.
createLabel(name) GmailLabel Создайте новую метку пользователя с заданным именем.
deleteLabel(label) GmailApp Удаляет указанную метку.
getAliases() String[] Получает список адресов электронной почты, настроенных как псевдонимы для этой учетной записи в Gmail.
getDraft(draftId) GmailDraft Получить черновик сообщения электронной почты по идентификатору.
getDraftMessages() GmailMessage[] Извлекает все черновики сообщений.
getDrafts() GmailDraft[] Получает все черновики сообщений Gmail.
getInboxThreads() GmailThread[] Извлекает все потоки папки "Входящие" независимо от меток.
getInboxThreads(start, max) GmailThread[] Извлекает диапазон цепочек входящих сообщений независимо от меток.
getInboxUnreadCount() Integer Получает количество непрочитанных тем в папке «Входящие».
getMessageById(id) GmailMessage Получает сообщение по ID.
getMessagesForThread(thread) GmailMessage[] Получить все сообщения в указанном потоке.
getMessagesForThreads(threads) GmailMessage[][] Получить все сообщения в указанных потоках.
getPriorityInboxThreads() GmailThread[] Извлекает все потоки из папки «Приоритетные входящие» независимо от меток.
getPriorityInboxThreads(start, max) GmailThread[] Извлекает диапазон цепочек из папки «Приоритетные входящие» независимо от меток.
getPriorityInboxUnreadCount() Integer Получает количество непрочитанных цепочек в папке "Приоритетные".
getSpamThreads() GmailThread[] Извлекает все потоки спама независимо от меток.
getSpamThreads(start, max) GmailThread[] Извлекает диапазон потоков спама независимо от меток.
getSpamUnreadCount() Integer Получает количество непрочитанных тем, которые являются спамом.
getStarredThreads() GmailThread[] Извлекает все темы, помеченные звездочкой, независимо от меток.
getStarredThreads(start, max) GmailThread[] Извлекает диапазон тем, помеченных звездочкой, независимо от меток.
getStarredUnreadCount() Integer Получает количество непрочитанных потоков, отмеченных звездочкой.
getThreadById(id) GmailThread Получает поток по идентификатору.
getTrashThreads() GmailThread[] Извлекает все темы мусора независимо от меток.
getTrashThreads(start, max) GmailThread[] Извлекает диапазон потоков мусора независимо от меток.
getUserLabelByName(name) GmailLabel Извлекает метку по имени метки.
getUserLabels() GmailLabel[] Получает список меток, созданных пользователем.
markMessageRead(message) GmailApp Помечает это сообщение как прочитанное и принудительно обновляет сообщение.
markMessageUnread(message) GmailApp Помечает это сообщение как непрочитанное и принудительно обновляет сообщение.
markMessagesRead(messages) GmailApp Отмечает эти сообщения как прочитанные и принудительно обновляет сообщения.
markMessagesUnread(messages) GmailApp Помечает эти сообщения как непрочитанные и принудительно обновляет сообщения.
markThreadImportant(thread) GmailApp Отмечает этот поток как важный и принудительно обновляет поток.
markThreadRead(thread) GmailApp Помечает этот поток как прочитанный и принудительно обновляет поток.
markThreadUnimportant(thread) GmailApp Помечает этот поток как неважный и принудительно обновляет поток.
markThreadUnread(thread) GmailApp Помечает этот поток как непрочитанный и принудительно обновляет поток.
markThreadsImportant(threads) GmailApp Отмечает эти темы как важные и принудительно обновляет темы.
markThreadsRead(threads) GmailApp Помечает эти потоки как прочитанные и принудительно обновляет потоки.
markThreadsUnimportant(threads) GmailApp Помечает эти темы как неважные и принудительно обновляет темы.
markThreadsUnread(threads) GmailApp Помечает эти темы как непрочитанные и принудительно обновляет темы.
moveMessageToTrash(message) GmailApp Перемещает сообщение в корзину и принудительно обновляет сообщение.
moveMessagesToTrash(messages) GmailApp Перемещает указанные сообщения в корзину и принудительно обновляет сообщения.
moveThreadToArchive(thread) GmailApp Перемещает этот поток в архив и принудительно обновляет поток.
moveThreadToInbox(thread) GmailApp Перемещает этот поток в папку "Входящие" и принудительно обновляет поток.
moveThreadToSpam(thread) GmailApp Помещает этот поток в спам и принудительно обновляет поток.
moveThreadToTrash(thread) GmailApp Перемещает этот поток в корзину и принудительно обновляет поток.
moveThreadsToArchive(threads) GmailApp Перемещает эти потоки в архив и принудительно обновляет потоки.
moveThreadsToInbox(threads) GmailApp Перемещает эти темы в папку "Входящие" и принудительно обновляет темы.
moveThreadsToSpam(threads) GmailApp Перемещает эти темы в спам и принудительно обновляет темы.
moveThreadsToTrash(threads) GmailApp Перемещает эти потоки в корзину и принудительно обновляет потоки.
refreshMessage(message) GmailApp Перезагружает сообщение и связанное с ним состояние из Gmail (полезно, если метки, состояние чтения и т. д. изменились).
refreshMessages(messages) GmailApp Перезагружает сообщения и связанное с ними состояние из Gmail (полезно, если метки, состояние чтения и т. д. изменились).
refreshThread(thread) GmailApp Перезагружает поток и связанное с ним состояние из Gmail (полезно, если метки, состояние чтения и т. д. изменились).
refreshThreads(threads) GmailApp Перезагружает потоки и связанное с ними состояние из Gmail (полезно, если метки, состояние чтения и т. д. изменились).
search(query) GmailThread[] Найдите Gmail с заданным запросом.
search(query, start, max) GmailThread[] Найдите Gmail с заданным запросом.
sendEmail(recipient, subject, body) GmailApp Отправляет сообщение электронной почты.
sendEmail(recipient, subject, body, options) GmailApp Отправляет сообщение электронной почты с необязательными аргументами.
setCurrentMessageAccessToken(accessToken) void Задает токен доступа к текущему сообщению , который позволяет сценарию получать доступ к текущим свойствам GmailMessage .
starMessage(message) GmailApp Добавляет звездочку к этому сообщению и принудительно обновляет сообщение.
starMessages(messages) GmailApp Добавляет звездочки к этим сообщениям и принудительно обновляет сообщения.
unstarMessage(message) GmailApp Удаляет звездочку из этого сообщения и принудительно обновляет сообщение.
unstarMessages(messages) GmailApp Удаляет звездочки с этих сообщений и принудительно обновляет сообщения.

GmailAttachment

Методы

Метод Тип возврата Краткое описание
copyBlob() Blob Возвращает копию этого большого двоичного объекта.
getAs(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
getBytes() Byte[] Получает данные, хранящиеся в этом большом двоичном объекте.
getContentType() String Получает тип содержимого байтов в этом большом двоичном объекте.
getDataAsString() String Получает данные этого большого двоичного объекта в виде строки с кодировкой UTF-8.
getDataAsString(charset) String Получает данные этого большого двоичного объекта в виде строки с указанной кодировкой.
getHash() String Получает хэш содержимого SHA1 для этого вложения.
getName() String Получает имя этого большого двоичного объекта.
getSize() Integer Получает размер этого вложения.
isGoogleType() Boolean Возвращает, является ли этот большой двоичный объект файлом Google Workspace (Таблицы, Документы и т. д.).
setBytes(data) Blob Задает данные, хранящиеся в этом большом двоичном объекте.
setContentType(contentType) Blob Задает тип содержимого байтов в этом большом двоичном объекте.
setContentTypeFromExtension() Blob Задает тип содержимого байтов в этом большом двоичном объекте на основе расширения файла.
setDataFromString(string) Blob Задает данные этого большого двоичного объекта из строки с кодировкой UTF-8.
setDataFromString(string, charset) Blob Задает данные этого большого двоичного объекта из строки с указанной кодировкой.
setName(name) Blob Задает имя этого большого двоичного объекта.

GmailDraft

Методы

Метод Тип возврата Краткое описание
deleteDraft() void Удаляет этот черновик сообщения.
getId() String Получает идентификатор этого черновика сообщения.
getMessage() GmailMessage Возвращает GmailMessage, представляющий этот черновик.
getMessageId() String Возвращает идентификатор GmailMessage представляющего этот черновик.
send() GmailMessage Отправляет черновик сообщения электронной почты.
update(recipient, subject, body) GmailDraft Заменяет содержимое этого черновика сообщения.
update(recipient, subject, body, options) GmailDraft Заменяет содержимое этого черновика сообщения, используя необязательные аргументы.

GmailLabel

Методы

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

GmailMessage

Методы

Метод Тип возврата Краткое описание
createDraftReply(body) GmailDraft Создает черновик сообщения, отвечая отправителю этого сообщения, используя адрес для ответа.
createDraftReply(body, options) GmailDraft Создает черновик сообщения, отвечая отправителю этого сообщения, используя адрес для ответа с необязательными аргументами.
createDraftReplyAll(body) GmailDraft Создает черновик сообщения, отвечая отправителю, используя адрес для ответа и всех получателей этого сообщения.
createDraftReplyAll(body, options) GmailDraft Создает черновик сообщения, отвечая отправителю этого сообщения, используя адрес для ответа и всех получателей с необязательными аргументами.
forward(recipient) GmailMessage Пересылает это сообщение новым получателям.
forward(recipient, options) GmailMessage Пересылает это сообщение новым получателям с необязательными аргументами.
getAttachments() GmailAttachment[] Получает все вложения для этого сообщения.
getAttachments(options) GmailAttachment[] Получает все вложения для этого сообщения.
getBcc() String Получает разделенных запятыми получателей скрытой копии этого сообщения.
getBody() String Получает HTML-содержимое тела этого сообщения.
getCc() String Получает получателей, разделенных запятыми, для этого сообщения.
getDate() Date Получает дату и время этого сообщения.
getFrom() String Получает отправителя этого сообщения.
getHeader(name) String Получает значение заголовка RFC 2822 с учетом имени заголовка.
getId() String Получает идентификатор этого сообщения.
getPlainBody() String Получает содержимое тела этого сообщения без форматирования HTML.
getRawContent() String Получает необработанное содержимое этого сообщения.
getReplyTo() String Получает адрес для ответа на это сообщение (обычно отправителя).
getSubject() String Получает тему этого сообщения.
getThread() GmailThread Получает поток, содержащий это сообщение.
getTo() String Получает получателей этого сообщения, разделенных запятыми.
isDraft() Boolean Получает, является ли это сообщение черновиком.
isInChats() Boolean Получает, является ли это сообщение чатом.
isInInbox() Boolean Получает, находится ли это сообщение в папке "Входящие".
isInPriorityInbox() Boolean Возвращает true , если это сообщение находится в приоритетной папке входящих; в противном случае возвращает false .
isInTrash() Boolean Получает, находится ли это сообщение в корзине.
isStarred() Boolean Получает, помечено ли это сообщение.
isUnread() Boolean Получает, является ли это сообщение непрочитанным.
markRead() GmailMessage Помечает сообщение как прочитанное.
markUnread() GmailMessage Помечает сообщение как непрочитанное.
moveToTrash() GmailMessage Перемещает сообщение в корзину.
refresh() GmailMessage Перезагружает это сообщение и связанное с ним состояние из Gmail (полезно, если метки, состояние чтения и т. д. изменились).
reply(body) GmailMessage Отвечает отправителю этого сообщения, используя адрес для ответа.
reply(body, options) GmailMessage Отвечает отправителю этого сообщения, используя адрес для ответа с необязательными аргументами.
replyAll(body) GmailMessage Отвечает отправителю, используя адрес для ответа, и всем получателям этого сообщения.
replyAll(body, options) GmailMessage Отвечает отправителю этого сообщения, используя адрес для ответа и всех получателей с необязательными аргументами.
star() GmailMessage Помечает сообщение звездочкой.
unstar() GmailMessage Отменяет пометку сообщения.

GmailThread

Методы

Метод Тип возврата Краткое описание
addLabel(label) GmailThread Добавляет эту метку в поток.
createDraftReply(body) GmailDraft Создает черновик сообщения, отвечая отправителю последнего сообщения в этой ветке, используя адрес для ответа.
createDraftReply(body, options) GmailDraft Создает черновик сообщения, отвечая отправителю последнего сообщения в этой цепочке, используя адрес для ответа с необязательными аргументами.
createDraftReplyAll(body) GmailDraft Создает черновик сообщения, отвечая отправителю последнего сообщения в этой цепочке, используя адрес для ответа и всех получателей этого сообщения.
createDraftReplyAll(body, options) GmailDraft Создает черновик сообщения, отвечая отправителю последнего сообщения в этой цепочке, используя адрес для ответа и всех получателей с необязательными аргументами.
getFirstMessageSubject() String Получает тему первого сообщения в цепочке.
getId() String Получает идентификатор этого потока.
getLabels() GmailLabel[] Возвращает созданные пользователем метки в этом потоке.
getLastMessageDate() Date Получает дату самого последнего сообщения в этом потоке.
getMessageCount() Integer Возвращает количество сообщений в цепочке.
getMessages() GmailMessage[] Получает сообщения в этом потоке.
getPermalink() String Получает постоянную ссылку на этот поток.
hasStarredMessages() Boolean Возвращает, есть ли в потоке какие-либо помеченные сообщения.
isImportant() Boolean Возвращает значение, помеченное как важное.
isInChats() Boolean Возвращает, помечен ли поток как чат.
isInInbox() Boolean Возвращает, находится ли поток в папке «Входящие».
isInPriorityInbox() Boolean Возвращает true, если этот поток находится в приоритетной папке «Входящие»; в противном случае возвращает false.
isInSpam() Boolean Возвращает, помечен ли поток как спам.
isInTrash() Boolean Возвращает, находится ли поток в корзине.
isUnread() Boolean Возвращает, есть ли в потоке непрочитанные сообщения.
markImportant() GmailThread Отмечает эту тему как важную.
markRead() GmailThread Отмечает эту тему как прочитанную.
markUnimportant() GmailThread Отмечает эту тему как неважную.
markUnread() GmailThread Отмечает эту тему как непрочитанную.
moveToArchive() GmailThread Перемещает эту тему в архив.
moveToInbox() GmailThread Перемещает эту тему в папку "Входящие".
moveToSpam() GmailThread Перемещает эту тему в спам.
moveToTrash() GmailThread Перемещает эту тему в корзину.
refresh() GmailThread Перезагружает этот поток и связанное с ним состояние из Gmail (полезно, если метки, состояние чтения и т. д. изменились).
removeLabel(label) GmailThread Удаляет этот ярлык из цепочки.
reply(body) GmailThread Ответьте отправителю последнего сообщения в этой теме, используя адрес replyTo.
reply(body, options) GmailThread Ответьте отправителю последнего сообщения в этой ветке, используя адрес replyTo с необязательными аргументами.
replyAll(body) GmailThread Ответьте отправителю (используя адрес replyTo) и всем получателям последнего сообщения в этой ветке.
replyAll(body, options) GmailThread Ответ отправителю (используя адрес replyTo ) и всем получателям последнего сообщения в этом потоке с необязательными аргументами.