Class GmailDraft

GmailDraft

Черновик сообщения, созданный пользователем в его учетной записи Gmail.

Методы

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

Подробная документация

deleteDraft()

Удаляет этот черновик сообщения.

const 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()

Получает идентификатор этого черновика сообщения.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const draftId = draft.getId();
const draftById = GmailApp.getDraft(draftId);
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

Возвращаться

String — идентификатор черновика

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getMessage()

Возвращает сообщение GmailMessage, представляющее этот черновик.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const message = draft.getMessage();
Logger.log(message.getSubject());

Возвращаться

GmailMessage — сообщение, представляющее собой содержимое этого черновика.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

getMessageId()

Возвращает идентификатор сообщения GmailMessage , представляющего этот черновик.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const messageId = draft.getMessageId();
Logger.log(messageId === draft.getMessage().getId());

Возвращаться

String — идентификатор сообщения

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

send()

Отправляет черновик электронного письма. Размер письма (включая заголовки) ограничен установленной квотой .

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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 Blob Source[] массив файлов для отправки вместе с электронным письмом
bcc String Список адресов электронной почты, разделенных запятыми, для добавления в скрытую копию (BCC).
cc String Список адресов электронной почты, разделенных запятыми, для указания в копии.
from String Адрес, с которого должно быть отправлено электронное письмо, должен совпадать с одним из значений, возвращаемых функцией Gmail App.getAliases()
html Body String Если этот параметр задан, устройства, способные отображать HTML, будут использовать его вместо обязательного аргумента body; вы можете добавить необязательное поле inline Images в тело HTML-сообщения, если у вас есть встроенные изображения для ваших электронных писем.
inline Images Object Объект JavaScript, содержащий сопоставление ключа изображения ( String ) с данными изображения ( Blob Source ); предполагается, что используется параметр html Body , и содержит ссылки на эти изображения в формате <img src="cid:imageKey" />
name String Имя отправителя электронного письма (по умолчанию: имя пользователя)
reply To String Адрес электронной почты, который будет использоваться в качестве адреса для ответа по умолчанию (по умолчанию: адрес электронной почты пользователя).

Возвращаться

GmailDraft — обновленная версия черновика

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://mail.google.com/

См. также