Gmail Service

Gmail

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

Классы

Имя Краткое описание
Gmail App Предоставляет доступ к веткам, сообщениям и ярлыкам Gmail.
Gmail Attachment Вложение из Gmail.
Gmail Draft Созданный пользователем черновик сообщения в его учетной записи Gmail.
Gmail Label Ярлык, созданный пользователем в его учетной записи Gmail.
Gmail Message Сообщение в аккаунте Gmail пользователя.
Gmail Thread Ветка в аккаунте Gmail пользователя.

Gmail App

Методы

Метод Тип возврата Краткое описание
create Draft(recipient, subject, body) Gmail Draft Создает черновик сообщения электронной почты.
create Draft(recipient, subject, body, options) Gmail Draft Создает черновик сообщения электронной почты с необязательными аргументами.
create Label(name) Gmail Label Создайте новый ярлык пользователя с указанным именем.
delete Label(label) Gmail App Удаляет указанную метку.
get Aliases() String[] Получает список адресов электронной почты, настроенных в качестве псевдонимов для этой учетной записи в Gmail.
get Draft(draftId) Gmail Draft Получить черновик сообщения электронной почты по идентификатору.
get Draft Messages() Gmail Message[] Извлекает все черновики сообщений.
get Drafts() Gmail Draft[] Получает все черновики сообщений Gmail.
get Inbox Threads() Gmail Thread[] Извлекает все цепочки входящих сообщений независимо от меток.
get Inbox Threads(start, max) Gmail Thread[] Извлекает ряд входящих сообщений независимо от меток.
get Inbox Unread Count() Integer Получает количество непрочитанных сообщений в папке «Входящие».
get Message By Id(id) Gmail Message Получает сообщение по идентификатору.
get Messages For Thread(thread) Gmail Message[] Получить все сообщения в указанной ветке.
get Messages For Threads(threads) Gmail Message[][] Получить все сообщения в указанных потоках.
get Priority Inbox Threads() Gmail Thread[] Извлекает все цепочки сообщений в папке «Приоритетные входящие» независимо от меток.
get Priority Inbox Threads(start, max) Gmail Thread[] Извлекает ряд цепочек сообщений из папки «Приоритетные входящие» независимо от меток.
get Priority Inbox Unread Count() Integer Возвращает количество непрочитанных сообщений в папке «Приоритетные».
get Spam Threads() Gmail Thread[] Извлекает все спам-треды независимо от меток.
get Spam Threads(start, max) Gmail Thread[] Извлекает ряд спам-тем независимо от меток.
get Spam Unread Count() Integer Получает количество непрочитанных сообщений, являющихся спамом.
get Starred Threads() Gmail Thread[] Возвращает все отмеченные темы независимо от меток.
get Starred Threads(start, max) Gmail Thread[] Возвращает ряд отмеченных тем независимо от меток.
get Starred Unread Count() Integer Получает количество непрочитанных сообщений, отмеченных звездочкой.
get Thread By Id(id) Gmail Thread Получает поток по идентификатору.
get Trash Threads() Gmail Thread[] Возвращает все нежелательные темы независимо от меток.
get Trash Threads(start, max) Gmail Thread[] Извлекает ряд нежелательных тем независимо от меток.
get User Label By Name(name) Gmail Label Возвращает метку по заданному имени метки.
get User Labels() Gmail Label[] Возвращает список меток, созданных пользователем.
mark Message Read(message) Gmail App Отмечает сообщение как прочитанное и принудительно обновляет его.
mark Message Unread(message) Gmail App Отмечает это сообщение как непрочитанное и принудительно обновляет его.
mark Messages Read(messages) Gmail App Отмечает эти сообщения как прочитанные и принудительно обновляет их.
mark Messages Unread(messages) Gmail App Отмечает эти сообщения как непрочитанные и принудительно обновляет их.
mark Thread Important(thread) Gmail App Отмечает эту ветку как важную и принудительно обновляет ее.
mark Thread Read(thread) Gmail App Отмечает эту ветку как прочитанную и принудительно обновляет ее.
mark Thread Unimportant(thread) Gmail App Отмечает эту ветку как неважную и принудительно обновляет ее.
mark Thread Unread(thread) Gmail App Отмечает эту ветку как непрочитанную и принудительно обновляет ее.
mark Threads Important(threads) Gmail App Отмечает эти темы как важные и принудительно обновляет их.
mark Threads Read(threads) Gmail App Отмечает эти темы как прочитанные и принудительно обновляет их.
mark Threads Unimportant(threads) Gmail App Отмечает эти темы как неважные и принудительно обновляет их.
mark Threads Unread(threads) Gmail App Отмечает эти темы как непрочитанные и принудительно обновляет их.
move Message To Trash(message) Gmail App Перемещает сообщение в корзину и принудительно обновляет его.
move Messages To Trash(messages) Gmail App Перемещает указанные сообщения в корзину и принудительно обновляет их.
move Thread To Archive(thread) Gmail App Перемещает эту ветку в архив и принудительно обновляет ее.
move Thread To Inbox(thread) Gmail App Перемещает эту ветку в папку «Входящие» и принудительно обновляет ее.
move Thread To Spam(thread) Gmail App Перемещает эту ветку в спам и принудительно обновляет ее.
move Thread To Trash(thread) Gmail App Перемещает эту ветку в корзину и принудительно обновляет ее.
move Threads To Archive(threads) Gmail App Перемещает эти темы в архив и принудительно обновляет их.
move Threads To Inbox(threads) Gmail App Перемещает эти цепочки в папку «Входящие» и принудительно обновляет их.
move Threads To Spam(threads) Gmail App Перемещает эти темы в спам и принудительно обновляет их.
move Threads To Trash(threads) Gmail App Перемещает эти темы в корзину и принудительно обновляет их.
refresh Message(message) Gmail App Перезагружает сообщение и связанное с ним состояние из Gmail (полезно в случае, если изменились метки, состояние прочтения и т. д.).
refresh Messages(messages) Gmail App Перезагружает сообщения и связанное с ними состояние из Gmail (полезно в случае, если изменились метки, состояние прочтения и т. д.).
refresh Thread(thread) Gmail App Перезагружает ветку и связанное с ней состояние из Gmail (полезно в случае, если метки, состояние прочтения и т. д. изменились).
refresh Threads(threads) Gmail App Перезагружает цепочки и связанное с ними состояние из Gmail (полезно в случае, если метки, состояние прочтения и т. д. изменились).
search(query) Gmail Thread[] Выполните поиск в Gmail по данному запросу.
search(query, start, max) Gmail Thread[] Выполните поиск в Gmail по данному запросу.
send Email(recipient, subject, body) Gmail App Отправляет сообщение по электронной почте.
send Email(recipient, subject, body, options) Gmail App Отправляет сообщение электронной почты с необязательными аргументами.
set Current Message Access Token(accessToken) void Устанавливает текущий токен доступа к сообщению , который позволяет скрипту получать доступ к текущим свойствам Gmail Message .
star Message(message) Gmail App Добавляет звездочку к данному сообщению и принудительно обновляет его.
star Messages(messages) Gmail App Добавляет звездочки к этим сообщениям и принудительно обновляет их.
unstar Message(message) Gmail App Удаляет звездочку с сообщения и принудительно обновляет его.
unstar Messages(messages) Gmail App Удаляет звездочки с сообщений и принудительно обновляет их.

Gmail Attachment

Методы

Метод Тип возврата Краткое описание
copy Blob() Blob Возвращает копию этого объекта.
get As(contentType) Blob Возвращает данные из этого объекта в виде двоичного двоичного объекта, преобразованного в указанный тип содержимого.
get Bytes() Byte[] Получает данные, хранящиеся в этом BLOB-объекте.
get Content Type() String Получает тип содержимого байтов в этом BLOB-объекте.
get Data As String() String Получает данные этого объекта в виде строки с кодировкой UTF-8.
get Data As String(charset) String Получает данные этого BLOB-объекта в виде строки с указанной кодировкой.
get Hash() String Получает хэш содержимого SHA1 для этого вложения.
get Name() String Получает имя этого объекта.
get Size() Integer Получает размер этого вложения.
is Google Type() Boolean Возвращает, является ли этот объект файлом Google Workspace (таблицы, документы и т. д.).
set Bytes(data) Blob Задает данные, хранящиеся в этом BLOB-объекте.
set Content Type(contentType) Blob Задает тип содержимого байтов в этом блобе.
set Content Type From Extension() Blob Устанавливает тип содержимого байтов в данном двоичном объекте на основе расширения файла.
set Data From String(string) Blob Устанавливает данные этого BLOB-объекта из строки с кодировкой UTF-8.
set Data From String(string, charset) Blob Устанавливает данные этого BLOB-объекта из строки с указанной кодировкой.
set Name(name) Blob Задает имя данного объекта.

Gmail Draft

Методы

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

Gmail Label

Методы

Метод Тип возврата Краткое описание
add To Thread(thread) Gmail Label Добавляет эту метку к указанному потоку и принудительно обновляет поток ( Gmail Thread.refresh() ).
add To Threads(threads) Gmail Label Добавляет эту метку к указанным потокам и принудительно обновляет потоки.
delete Label() void Удаляет эту метку.
get Id() String Получает идентификатор этой метки.
get Name() String Получает имя этой метки.
get Threads() Gmail Thread[] Получает потоки, отмеченные этой меткой.
get Threads(start, max) Gmail Thread[] Получает ряд потоков, отмеченных этой меткой.
get Unread Count() Integer Возвращает количество непрочитанных сообщений, отмеченных этой меткой.
remove From Thread(thread) Gmail Label Удаляет эту метку из указанного потока и принудительно обновляет поток.
remove From Threads(threads) Gmail Label Удаляет эту метку из указанных потоков и принудительно обновляет потоки.

Gmail Message

Методы

Метод Тип возврата Краткое описание
create Draft Reply(body) Gmail Draft Создает черновик сообщения с ответом отправителю данного сообщения, используя адрес для ответа.
create Draft Reply(body, options) Gmail Draft Создает черновик сообщения с ответом отправителю данного сообщения, используя адрес для ответа, с необязательными аргументами.
create Draft Reply All(body) Gmail Draft Создает черновик сообщения с ответом отправителю, используя адрес для ответа, и всем получателям этого сообщения.
create Draft Reply All(body, options) Gmail Draft Создает черновик сообщения с ответом отправителю данного сообщения, используя адрес для ответа и всех получателей, с необязательными аргументами.
forward(recipient) Gmail Message Пересылает это сообщение новым получателям.
forward(recipient, options) Gmail Message Пересылает это сообщение новым получателям с необязательными аргументами.
get Attachments() Gmail Attachment[] Получает все вложения для этого сообщения.
get Attachments(options) Gmail Attachment[] Получает все вложения для этого сообщения.
get Bcc() String Получает скрытую копию этого сообщения всем получателям, разделенным запятыми.
get Body() String Получает HTML-содержимое тела этого сообщения.
get Cc() String Получает список получателей, указанных через запятую, в копии этого сообщения.
get Date() Date Получает дату и время этого сообщения.
get From() String Получает отправителя этого сообщения.
get Header(name) String Получает значение заголовка RFC 2822 по заданному имени заголовка.
get Id() String Получает идентификатор этого сообщения.
get Plain Body() String Получает содержимое тела этого сообщения без HTML-форматирования.
get Raw Content() String Получает необработанное содержимое этого сообщения.
get Reply To() String Получает адрес для ответа на это сообщение (обычно отправителя).
get Subject() String Получает тему этого сообщения.
get Thread() Gmail Thread Получает поток, содержащий это сообщение.
get To() String Получает получателей этого сообщения, разделенных запятыми.
is Draft() Boolean Проверяет, является ли сообщение черновиком.
is In Chats() Boolean Проверяет, является ли это сообщение чатом.
is In Inbox() Boolean Проверяет, находится ли данное сообщение в папке «Входящие».
is In Priority Inbox() Boolean Возвращает true , если сообщение находится в папке «Приоритетные входящие»; в противном случае возвращает false .
is In Trash() Boolean Проверяет, находится ли это сообщение в корзине.
is Starred() Boolean Проверяет, отмечено ли это сообщение звездочкой.
is Unread() Boolean Проверяет, является ли это сообщение непрочитанным.
mark Read() Gmail Message Отмечает сообщение как прочитанное.
mark Unread() Gmail Message Отмечает сообщение как непрочитанное.
move To Trash() Gmail Message Перемещает сообщение в корзину.
refresh() Gmail Message Перезагружает это сообщение и связанное с ним состояние из Gmail (полезно в случае, если метки, состояние прочтения и т. д. изменились).
reply(body) Gmail Message Отвечает отправителю данного сообщения, используя адрес для ответа.
reply(body, options) Gmail Message Отвечает отправителю данного сообщения, используя адрес для ответа, с необязательными аргументами.
reply All(body) Gmail Message Ответ отправителю, используя адрес для ответа, и всем получателям этого сообщения.
reply All(body, options) Gmail Message Отвечает отправителю данного сообщения, используя адрес для ответа, и всем получателям, с необязательными аргументами.
star() Gmail Message Отмечает сообщение звездочкой.
unstar() Gmail Message Снять пометку с сообщения.

Gmail Thread

Методы

Метод Тип возврата Краткое описание
add Label(label) Gmail Thread Добавляет эту метку в ветку.
create Draft Reply(body) Gmail Draft Создает черновик сообщения с ответом отправителю последнего сообщения в этой ветке, используя адрес для ответа.
create Draft Reply(body, options) Gmail Draft Создает черновик сообщения с ответом отправителю последнего сообщения в этой ветке, используя адрес для ответа, с необязательными аргументами.
create Draft Reply All(body) Gmail Draft Создает черновик сообщения с ответом отправителю последнего сообщения в этой ветке, используя адрес для ответа и всех получателей этого сообщения.
create Draft Reply All(body, options) Gmail Draft Создает черновик сообщения с ответом отправителю последнего сообщения в этой цепочке, используя адрес для ответа и всех получателей, с необязательными аргументами.
get First Message Subject() String Получает тему первого сообщения в ветке.
get Id() String Получает идентификатор этого потока.
get Labels() Gmail Label[] Возвращает созданные пользователем метки в этом потоке.
get Last Message Date() Date Получает дату последнего сообщения в этой теме.
get Message Count() Integer Возвращает количество сообщений в цепочке.
get Messages() Gmail Message[] Получает сообщения в этой ветке.
get Permalink() String Получает постоянную ссылку на эту ветку.
has Starred Messages() Boolean Возвращает, есть ли в ветке отмеченные сообщения.
is Important() Boolean Возвращает, отмечена ли тема как важная.
is In Chats() Boolean Возвращает, помечена ли тема как чат.
is In Inbox() Boolean Возвращает, находится ли тема в папке «Входящие».
is In Priority Inbox() Boolean Возвращает true, если эта тема находится в папке «Приоритетные входящие»; в противном случае возвращает false.
is In Spam() Boolean Возвращает, отмечена ли тема как спам.
is In Trash() Boolean Возвращает, находится ли поток в корзине.
is Unread() Boolean Возвращает, есть ли в потоке непрочитанные сообщения.
mark Important() Gmail Thread Отмечает эту ветку как важную.
mark Read() Gmail Thread Отмечает эту ветку как прочитанную.
mark Unimportant() Gmail Thread Отмечает эту ветку как неважную.
mark Unread() Gmail Thread Отмечает эту ветку как непрочитанную.
move To Archive() Gmail Thread Перемещает эту ветку в архив.
move To Inbox() Gmail Thread Перемещает эту ветку в папку «Входящие».
move To Spam() Gmail Thread Перемещает эту ветку в спам.
move To Trash() Gmail Thread Перемещает эту ветку в корзину.
refresh() Gmail Thread Перезагружает эту ветку и связанное с ней состояние из Gmail (полезно в случае, если метки, состояние прочтения и т. д. изменились).
remove Label(label) Gmail Thread Удаляет эту метку из ветки.
reply(body) Gmail Thread Ответьте отправителю последнего сообщения в этой ветке, используя адрес replyTo.
reply(body, options) Gmail Thread Ответьте отправителю последнего сообщения в этой ветке, используя адрес replyTo, с необязательными аргументами.
reply All(body) Gmail Thread Ответьте отправителю (используя адрес replyTo) и всем получателям последнего сообщения в этой ветке.
reply All(body, options) Gmail Thread Ответить отправителю (используя адрес reply To ) и всем получателям последнего сообщения в этой ветке, указав необязательные аргументы.