Class GmailDraft

GmailDraft

用户在 Gmail 账号中创建的草稿邮件。

方法

方法返回类型简介
deleteDraft()void删除此邮件草稿。
getId()String获取此草稿消息的 ID。
getMessage()GmailMessage返回代表此草稿的 GmailMessage。
getMessageId()String返回代表此草稿的 GmailMessage 的 ID。
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()

获取此草稿消息的 ID。 

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 - 草稿 ID

授权

使用此方法的脚本需要以下一个或多个范围或相关 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 的 ID。 

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

返回

String - 消息 ID

授权

使用此方法的脚本需要以下一个或多个范围或相关 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());

参数

名称类型说明
recipientString以英文逗号分隔的电子邮件地址列表
subjectString电子邮件主题（最多 250 个字符）
bodyString电子邮件正文

返回

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'
});

参数

名称类型说明
recipientString以英文逗号分隔的电子邮件地址列表
subjectString电子邮件主题（最多 250 个字符）
bodyString电子邮件正文
optionsObject一个用于指定高级参数（如下所列）的 JavaScript 对象

高级参数

名称类型说明
attachmentsBlobSource[]一 随电子邮件地址一起发送的文件数组
bccString要密送的电子邮件地址的逗号分隔列表
ccString要抄送的电子邮件地址的逗号分隔列表
fromString发送电子邮件的发件地址，必须为该地址 的 GmailApp.getAliases() 返回的值
htmlBodyString如果已设置，则能够呈现 HTML 的设备将改用 HTML 源代码。 所需的 body 参数；您可以在 HTML 中添加一个可选的 inlineImages 字段 body（如果您的电子邮件有内嵌图片）
inlineImagesObject包含图片键映射的 JavaScript 对象 (String) 对图片数据 (BlobSource)；这里假定使用了 htmlBody 参数，并以 <img src="cid:imageKey" /> 格式包含对这些图片的引用
nameString电子邮件发件人的姓名（默认：用户的姓名）
replyToString用作默认回复地址的电子邮件地址 （默认值：用户的电子邮件地址）

返回

GmailDraft - 最近更新的草稿

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

  • https://mail.google.com/

另请参阅