Созданный пользователем черновик сообщения в учетной записи Gmail пользователя.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
deleteDraft() | void | Удаляет этот черновик сообщения. |
getId() | String | Получает идентификатор этого черновика сообщения. |
getMessage() | GmailMessage | Возвращает сообщение GmailMessage, представляющее этот черновик. |
getMessageId() | String | Возвращает идентификатор сообщения GmailMessage представляющего этот черновик. |
send() | GmailMessage | Отправляет этот черновик сообщения электронной почты. |
update(recipient, subject, body) | GmailDraft | Заменяет содержимое этого черновика сообщения. |
update(recipient, subject, body, options) | GmailDraft | Заменяет содержимое этого черновика сообщения, используя необязательные аргументы. |
Подробная документация
deleteDraft()
Удаляет этот черновик сообщения.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder draft.deleteDraft(); draft.getMessage(); // Throws exception.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/
getId()
Получает идентификатор этого черновика сообщения.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder var draftId = draft.getId(); var draftById = GmailApp.getDraft(draftId); Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());
Возвращаться
String
— идентификатор черновика
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/
getMessage()
Возвращает сообщение GmailMessage, представляющее этот черновик.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder var message = draft.getMessage(); Logger.log(message.getSubject());
Возвращаться
GmailMessage
— сообщение, представляющее содержимое этого черновика.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/
getMessageId()
Возвращает идентификатор сообщения GmailMessage
представляющего этот черновик.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder var messageId = draft.getMessageId(); Logger.log(messageId == draft.getMessage().getId());
Возвращаться
String
— идентификатор сообщения
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/
send()
Отправляет этот черновик сообщения электронной почты. Размер электронного письма (включая заголовки) ограничен квотой .
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder var msg = draft.send(); // Send it Logger.log(msg.getDate()); // Should be approximately the current timestamp
Возвращаться
GmailMessage
— новое отправленное сообщение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/
update(recipient, subject, body)
Заменяет содержимое этого черновика сообщения. Размер электронного письма (включая заголовки) ограничен квотой .
// The code below will update a draft email with the current date and time. var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder var now = new Date(); draft.update("mike@example.com", "current time", "The time is: " + now.toString());
Параметры
Имя | Тип | Описание |
---|---|---|
recipient | String | список адресов электронной почты, разделенный запятыми |
subject | String | тема письма (максимум 250 символов) |
body | String | тело электронного письма |
Возвращаться
GmailDraft
— недавно обновленный проект
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/
См. также
update(recipient, subject, body, options)
Заменяет содержимое этого черновика сообщения, используя необязательные аргументы. Электронное письмо может содержать обычный текст или тело HTML. Размер электронного письма (включая заголовки) ограничен квотой .
// Update a draft email with a file from Google Drive attached as a PDF. var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); draft.update('mike@example.com', 'Attachment example', 'Please see attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Параметры
Имя | Тип | Описание |
---|---|---|
recipient | String | список адресов электронной почты, разделенный запятыми |
subject | String | тема письма (максимум 250 символов) |
body | String | тело электронного письма |
options | Object | объект JavaScript, который определяет дополнительные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
attachments | BlobSource[] | массив файлов для отправки по электронной почте |
bcc | String | список адресов электронной почты, разделенных запятыми, для BCC |
cc | String | список адресов электронной почты, разделенных запятыми, для CC |
from | String | адрес, с которого должно быть отправлено электронное письмо, который должен быть одним из значений, возвращаемых GmailApp.getAliases() |
htmlBody | String | если установлено, устройства, способные отображать HTML, будут использовать его вместо обязательного аргумента тела; вы можете добавить дополнительное поле inlineImages в тело HTML, если у вас есть встроенные изображения для вашей электронной почты. |
inlineImages | Object | объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( BlobSource ); при этом предполагается, что используется параметр htmlBody и содержит ссылки на эти изображения в формате <img src="cid:imageKey" /> |
name | String | имя отправителя электронного письма (по умолчанию: имя пользователя) |
replyTo | String | адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя) |
Возвращаться
GmailDraft
— недавно обновленный проект
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://mail.google.com/