Gmail Service

Гмайл

Эта служба позволяет отправлять электронные письма, создавать черновики, управлять метками, помечать сообщения и цепочки сообщений, а также выполнять множество других задач по управлению учетной записью 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 |null Получает ветку обсуждения по ID.
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 Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Bytes() Byte[] Получает данные, хранящиеся в этом блоке.
get Content Type() String|null Получает тип содержимого байтов в этом блоке данных.
get Data As String() String Получает данные этого объекта в виде строки с кодировкой UTF-8.
get Data As String(charset) String Получает данные этого объекта в виде строки с указанной кодировкой.
get Hash() String Получает хеш содержимого SHA1 для этого вложения.
get Name() String|null Получает имя этого объекта.
get Size() Integer Определяет размер этого вложения.
is Google Type() Boolean Возвращает значение, указывающее, является ли данный объект файлом Google Workspace (Sheets, Docs и т. д.).
set Bytes(data) 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 Возвращает значение true, если ветка обсуждения находится во входящих сообщениях.
is In Priority Inbox() Boolean Возвращает true, если данная тема находится в папке "Входящие" с приоритетом; в противном случае возвращает false.
is In Spam() Boolean Возвращает значение, указывающее, помечена ли ветка обсуждения как спам.
is In Trash() Boolean Возвращает значение true, если поток находится в корзине.
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 ) и всем получателям последнего сообщения в этой ветке обсуждения, указав необязательные аргументы.