Эта служба позволяет отправлять электронную почту, создавать черновики, управлять метками, отмечать сообщения и цепочки, а также выполнять множество других задач по управлению учетной записью Gmail. См. также Mail Service — более простой сервис, позволяющий только отправлять электронную почту.
Классы
| Имя | Краткое описание |
|---|---|
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 | Получает сообщение по идентификатору. |
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 | Ответьте отправителю последнего сообщения в этой теме, используя адрес для ответа. |
reply(body, options) | GmailThread | Ответьте отправителю последнего сообщения в этой теме, используя адрес AnswerTo с необязательными аргументами. |
replyAll(body) | GmailThread | Ответьте отправителю (используя адрес AnswerTo) и всем получателям последнего сообщения в этой теме. |
replyAll(body, options) | GmailThread | Ответьте отправителю (используя адрес replyTo ) и всем получателям последнего сообщения в этой цепочке с необязательными аргументами. |