用户在用户的 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());
参数
名称 | 类型 | 说明 |
---|---|---|
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 | 要密送至的一系列电子邮件地址(以英文逗号分隔) |
cc | String | 要抄送的电子邮件地址的逗号分隔列表 |
from | String | 发送电子邮件时应使用的地址,必须是 GmailApp.getAliases() 返回的值之一 |
htmlBody | String | 如果设置了该字段,能够呈现 HTML 的设备将使用它,而不是必需的 body 参数;如果您有用于电子邮件的内嵌图片,则可以在 HTML 正文中添加可选的 inlineImages 字段 |
inlineImages | Object | 一个 JavaScript 对象,其中包含从图片键 (String ) 到图片数据 (BlobSource ) 的映射;这假定使用 htmlBody 参数,并包含对 <img src="cid:imageKey" /> 格式这些图片的引用 |
name | String | 电子邮件发件人的姓名(默认值:用户的姓名) |
replyTo | String | 用作默认回复地址的电子邮件地址(默认:用户的电子邮件地址) |
弃踢回攻
GmailDraft
- 最近更新的草稿
授权
使用此方法的脚本需要获得以下一个或多个范围或相关 REST API 的适当范围的授权:
-
https://mail.google.com/