此页面由 Cloud Translation API 翻译。

Class GmailMessage

用户的 Gmail 帐号中的邮件。

方法

方法	返回类型	简介
`createDraftReply(body)`	`GmailDraft`	创建用回复地址回复此邮件发件人的草稿邮件。
`createDraftReply(body, options)`	`GmailDraft`	创建使用回复地址回复此邮件发件人的草稿邮件，其中包含可选参数。
`createDraftReplyAll(body)`	`GmailDraft`	创建使用回复地址及此邮件的所有收件人回复发件人的草稿邮件。
`createDraftReplyAll(body, options)`	`GmailDraft`	创建使用回复地址及所有收件人（可选参数）回复此邮件发件人的草稿邮件。
`forward(recipient)`	`GmailMessage`	将此邮件转发给新的收件人。
`forward(recipient, options)`	`GmailMessage`	将此邮件（带有可选参数）转发给新收件人。
`getAttachments()`	`GmailAttachment[]`	获取该邮件的所有附件。
`getAttachments(options)`	`GmailAttachment[]`	获取该邮件的所有附件。
`getBcc()`	`String`	获取此邮件的以英文逗号分隔的密送收件人。
`getBody()`	`String`	获取此消息正文的 HTML 内容。
`getCc()`	`String`	获取此邮件的逗号分隔收件人。
`getDate()`	`Date`	获取此消息的日期和时间。
`getFrom()`	`String`	获取该邮件的发件人。
`getHeader(name)`	`String`	根据标头名称获取 RFC 2822 标头的值。
`getId()`	`String`	获取此消息的 ID。
`getPlainBody()`	`String`	获取不正文 HTML 格式的正文内容。
`getRawContent()`	`String`	获取此消息的原始内容。
`getReplyTo()`	`String`	获取该邮件的回复地址（通常是发件人）。
`getSubject()`	`String`	获取该邮件的主题。
`getThread()`	`GmailThread`	获取包含此消息的线程。
`getTo()`	`String`	获取此消息的逗号分隔收件人。
`isDraft()`	`Boolean`	获取此邮件是否为草稿。
`isInChats()`	`Boolean`	获取此消息是否为聊天对话。
`isInInbox()`	`Boolean`	获取此邮件是否在收件箱中。
`isInPriorityInbox()`	`Boolean`	如果此邮件位于优先收件箱中，则返回 `true`；否则返回 `false`。
`isInTrash()`	`Boolean`	获取此邮件是否在回收站中。
`isStarred()`	`Boolean`	获取该邮件是否已加星标。
`isUnread()`	`Boolean`	获取此邮件是否处于未读状态。
`markRead()`	`GmailMessage`	将邮件标记为已读。
`markUnread()`	`GmailMessage`	将邮件标记为未读。
`moveToTrash()`	`GmailMessage`	将邮件移至“已删除邮件”。
`refresh()`	`GmailMessage`	从 Gmail 重新加载此邮件和关联状态（在标签、读取状态等发生变化时非常有用）。
`reply(body)`	`GmailMessage`	使用回复地址回复此邮件的发件人。
`reply(body, options)`	`GmailMessage`	使用回复地址（包含可选参数）回复此邮件的发件人。
`replyAll(body)`	`GmailMessage`	使用回复地址以及此邮件的所有收件人回复发件人。
`replyAll(body, options)`	`GmailMessage`	使用回复地址及所有收件人（包含可选参数）回复此邮件。
`star()`	`GmailMessage`	为邮件加注星标。
`unstar()`	`GmailMessage`	移除该邮件的星标。

详细文档

`createDraftReply(body)`

创建用回复地址回复此邮件发件人的草稿邮件。电子邮件（包括标头）的大小有配额限制。

// Create a draft reply to the original message with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("Got your message");

参数

名称	类型	说明
`body`	`String`	电子邮件的正文。

GmailDraft - 新创建的消息草稿。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`createDraftReply(body, options)`

创建使用回复地址回复此邮件发件人的草稿邮件，其中包含可选参数。

该电子邮件可以包含纯文本和 HTML 正文。电子邮件（包括标头）的大小受到配额限制。

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

参数

名称	类型	说明
`body`	`String`	电子邮件的正文。
`options`	`Object`	一个 JavaScript 对象，用于指定高级参数，如下所示。

高级参数

名称	类型	说明
`attachments`	`BlobSource[]`	使用电子邮件发送的一组文件
`bcc`	`String`	密送至电子邮件地址的逗号分隔列表
`cc`	`String`	抄送抄送地址的逗号分隔列表
`from`	`String`	发送电子邮件的地址，必须是 `GmailApp.getAliases()` 返回的值之一
`htmlBody`	`String`	设置后，能够呈现 HTML 的设备会使用它（而非必需的正文参数）；如果您有内嵌的电子邮件图片，则可以在 HTML 正文中添加可选的 `inlineImages` 字段
`inlineImages`	`Object`	一个 JavaScript 对象，包含从图片键 (`String`) 到图片数据 (`BlobSource`) 的映射；此示例假设使用 `htmlBody` 参数并包含对图片的引用（格式为 `<img src="cid:imageKey" />`）
`name`	`String`	电子邮件发件人的姓名（默认：用户姓名）
`replyTo`	`String`	用作默认回复地址的电子邮件地址（默认：用户的电子邮件地址）
`subject`	`String`	电子邮件的新主题行

GmailDraft - 新创建的消息草稿。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

reply(body, options)
createDraftReply(body)
createDraftReplyAll(body)
createDraftReplyAll(body, options)

`createDraftReplyAll(body)`

创建使用回复地址及此邮件的所有收件人回复发件人的草稿邮件。电子邮件（包括标头）的大小有配额限制。

// Create a draft response to all recipients (except those bcc'd) with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

参数

名称	类型	说明
`body`	`String`	电子邮件的正文。

GmailDraft - 新创建的消息草稿。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

replyAll(body)
createDraftReply(body)
createDraftReply(body, options)
createDraftReplyAll(body, options)

`createDraftReplyAll(body, options)`

创建使用回复地址及所有收件人（可选参数）回复此邮件发件人的草稿。

该电子邮件可以包含纯文本和 HTML 正文。电子邮件（包括标头）的大小受到配额限制。

// Create a draft response to all recipients (except those bcc'd) using an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

参数

名称	类型	说明
`body`	`String`	电子邮件的正文。
`options`	`Object`	一个 JavaScript 对象，用于指定高级参数，如下所示。

高级参数

名称	类型	说明
`attachments`	`BlobSource[]`	使用电子邮件发送的一组文件
`bcc`	`String`	密送至电子邮件地址的逗号分隔列表
`cc`	`String`	抄送抄送地址的逗号分隔列表
`from`	`String`	发送电子邮件的地址，必须是 `GmailApp.getAliases()` 返回的值之一
`htmlBody`	`String`	设置后，能够呈现 HTML 的设备会使用它（而非必需的正文参数）；如果您有内嵌的电子邮件图片，则可以在 HTML 正文中添加可选的 `inlineImages` 字段
`inlineImages`	`Object`	一个 JavaScript 对象，包含从图片键 (`String`) 到图片数据 (`BlobSource`) 的映射；此示例假设使用 `htmlBody` 参数并包含对图片的引用（格式为 `<img src="cid:imageKey" />`）
`name`	`String`	电子邮件发件人的姓名（默认：用户姓名）
`replyTo`	`String`	用作默认回复地址的电子邮件地址（默认：用户的电子邮件地址）
`subject`	`String`	电子邮件的新主题行

GmailDraft - 新创建的消息草稿。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

replyAll(body, options)
createDraftReply(body)
createDraftReply(body, options)
createDraftReplyAll(body)

`forward(recipient)`

将此邮件转发给新的收件人。电子邮件（包括标头）的大小有配额限制。

// Forward first message of first inbox thread to recipient1 & recipient2, both @example.com
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com");

参数

名称	类型	说明
`recipient`	`String`	以英文逗号分隔的电子邮件地址列表。

GmailMessage - 此消息适用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

forward(recipient, options)

`forward(recipient, options)`

将此邮件连同可选的参数一起转发给新的收件人。

该电子邮件可以包含纯文本和 HTML 正文。电子邮件（包括标头）的大小有配额限制。

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com", {
  cc: "myboss@example.com",
  bcc: "mybosses-boss@example.com,vp@example.com"
});

参数

名称	类型	说明
`recipient`	`String`	以英文逗号分隔的电子邮件地址列表。
`options`	`Object`	一个 JavaScript 对象，用于指定高级参数，如下所示。

高级参数

名称	类型	说明
`attachments`	`BlobSource[]`	使用电子邮件发送的一组文件
`bcc`	`String`	密送至电子邮件地址的逗号分隔列表
`cc`	`String`	抄送抄送地址的逗号分隔列表
`from`	`String`	发送电子邮件的地址，必须是 `GmailApp.getAliases()` 返回的值之一
`htmlBody`	`String`	设置后，能够呈现 HTML 的设备会使用它（而非必需的正文参数）；如果您有内嵌的电子邮件图片，则可以在 HTML 正文中添加可选的 `inlineImages` 字段
`inlineImages`	`Object`	一个 JavaScript 对象，包含从图片键 (`String`) 到图片数据 (`BlobSource`) 的映射；此示例假设使用 `htmlBody` 参数并包含对图片的引用（格式为 `<img src="cid:imageKey" />`）
`name`	`String`	电子邮件发件人的姓名（默认：用户姓名）
`noReply`	`Boolean`	如果电子邮件应通过无回复常规电子邮件地址发送，以防止收件人回复电子邮件，请使用 `true`；此选项仅适用于 Google Workspace 帐号，不适用于 Gmail 用户
`replyTo`	`String`	用作默认回复地址的电子邮件地址（默认：用户的电子邮件地址）
`subject`	`String`	电子邮件的新主题行

GmailMessage - 此消息适用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

forward(recipient)

`getAttachments()`

获取该邮件的所有附件。

GmailAttachment[] - 此邮件的 Blob 附件数组。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`getAttachments(options)`

获取该邮件的所有附件。

参数

名称	类型	说明
`options`	`Object`	一个 JavaScript 对象，用于指定高级参数，如下所示。

高级参数

名称	类型	说明
`includeInlineImages`	`Boolean`	如果返回的 Blob 附件数组应包含内嵌图片（默认值为 `true`），则为 `true`。
`includeAttachments`	`Boolean`	如果返回的 Blob 附件数组应包含常规（非内嵌）附件（默认为 `true`），则返回 `true`。

GmailAttachment[] - 此邮件的 Blob 附件数组。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`getBcc()`

获取此邮件的逗号分隔密送收件人。

根据定义，这是针对所有收到的邮件都为空。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBcc()); // Log bcc'd addresses

String - 此邮件的收件人应以英文逗号分隔。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

getTo()

`getBody()`

获取此消息正文的 HTML 内容。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBody()); // Log contents of the body

String - 该邮件的正文内容。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

getSubject()

`getCc()`

获取此邮件的逗号分隔收件人。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getCc()); // Log cc'd addresses

String - 此邮件的收件人应以英文逗号分隔。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

getTo()

`getDate()`

获取此消息的日期和时间。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getDate()); // Log date and time of the message

Date - 该邮件的日期和时间。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`getFrom()`

获取此消息的发送者。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getFrom()); // Log from address of the message

String - 邮件发件人的电子邮件地址。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

getReplyTo()

`getHeader(name)`

根据标头名称获取 RFC 2822 标头的值。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox.
var message = thread.getMessages()[0];         // Get the first message.
Logger.log(message.getHeader("Message-ID"));   // Logs the Message-ID RFC 2822 header.

参数

名称	类型	说明
`name`	`String`	RFC 标头的名称，不含冒号和值。

String - 标头的值，如果邮件中不存在标头，则为空字符串。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`getId()`

获取此消息的 ID。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
var id = message.getId();
var messageById = GmailApp.getMessageById(id);
Logger.log(message.getSubject() == messageById.getMessage()); // Always logs true

String - 消息 ID。

`getPlainBody()`

获取不正文 HTML 格式的正文内容。这比 getBody() 更复杂，并且需要更长时间。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getPlainBody()); // Log contents of the body

String - 此邮件的正文内容。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

getSubject()

`getRawContent()`

获取此消息的原始内容。这相当于 Gmail 界面中的“显示原始邮件”。

String - 此邮件的原始内容。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`getReplyTo()`

获取该邮件的回复地址（通常是发件人）。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getReplyTo()); // Logs reply-to address

String - 回复的电子邮件地址。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

getCc()

`getSubject()`

获取该邮件的主题。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getSubject()); // Log subject line

String - 此邮件的主题。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

getAttachments()

`getThread()`

获取包含此消息的线程。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getThread().getFirstMessageSubject() ==
           thread.getFirstMessageSubject()); // Always logs true

GmailThread - 包含此邮件的 GmailThread。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`getTo()`

获取此消息的逗号分隔收件人。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getTo()); // Log the recipient of message

String - 此邮件的收件人（以英文逗号分隔）。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

getCc()

`isDraft()`

获取此邮件是否为草稿。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

Boolean - 邮件是否为草稿。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`isInChats()`

获取此消息是否为聊天对话。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

Boolean - 消息是否为聊天对话。

`isInInbox()`

获取此邮件是否在收件箱中。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

Boolean - 邮件是否在收件箱中。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`isInPriorityInbox()`

如果此邮件位于优先收件箱中，则返回 true；否则返回 false。

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log("is in priority inbox? " + messages[i].isInPriorityInbox());
}

Boolean - 邮件是否在优先收件箱中。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`isInTrash()`

获取此邮件是否在回收站中。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

Boolean - 邮件是否位于“已删除邮件”中。

`isStarred()`

获取此信息是否已加星标。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

Boolean - 邮件是否已加星标。

`isUnread()`

获取此邮件是否处于未读状态。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

Boolean - 此邮件的未读状态。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`markRead()`

将邮件标记为已读。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markRead(); // Mark as read

GmailMessage - 此 GmailMessage，可用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

isUnread()

`markUnread()`

将邮件标记为未读。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markUnread(); // Mark as unread

GmailMessage - 此 GmailMessage，可用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

isUnread()

`moveToTrash()`

将邮件移至“已删除邮件”。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.moveToTrash(); // Move message to trash

GmailMessage - 此 GmailMessage，可用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

isInTrash()

`refresh()`

从 Gmail 重新加载此邮件和关联状态（在标签、读取状态等发生变化时非常有用）。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
// .. Do bunch of stuff here
message.refresh(); // Make sure it's up to date
// Do more stuff to message

GmailMessage - 这是用于链接的消息。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

`reply(body)`

使用回复地址回复此邮件的发件人。电子邮件（包括标头）的大小有配额限制。

// Respond to author of message with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("Got your message");

参数

名称	类型	说明
`body`	`String`	电子邮件的正文。

GmailMessage - 此消息适用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

reply(body, options)
replyAll(body)
replyAll(body, options)

`reply(body, options)`

使用回复地址（包含可选参数）回复此邮件的发件人。

该电子邮件可以包含纯文本和 HTML 正文。电子邮件（包括标头）的大小有配额限制。

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

参数

名称	类型	说明
`body`	`String`	电子邮件的正文。
`options`	`Object`	一个 JavaScript 对象，用于指定高级参数，如下所示。

高级参数

名称	类型	说明
`attachments`	`BlobSource[]`	使用电子邮件发送的一组文件
`bcc`	`String`	密送至电子邮件地址的逗号分隔列表
`cc`	`String`	抄送抄送地址的逗号分隔列表
`from`	`String`	发送电子邮件的地址，必须是 `GmailApp.getAliases()` 返回的值之一
`htmlBody`	`String`	设置后，能够呈现 HTML 的设备会使用它（而非必需的正文参数）；如果您有内嵌的电子邮件图片，则可以在 HTML 正文中添加可选的 `inlineImages` 字段
`inlineImages`	`Object`	一个 JavaScript 对象，包含从图片键 (`String`) 到图片数据 (`BlobSource`) 的映射；此示例假设使用 `htmlBody` 参数并包含对图片的引用（格式为 `<img src="cid:imageKey" />`）
`name`	`String`	电子邮件发件人的姓名（默认：用户姓名）
`noReply`	`Boolean`	如果电子邮件应通过无回复常规电子邮件地址发送，以防止收件人回复电子邮件，请使用 `true`；此选项仅适用于 Google Workspace 帐号，不适用于 Gmail 用户
`replyTo`	`String`	用作默认回复地址的电子邮件地址（默认：用户的电子邮件地址）
`subject`	`String`	电子邮件的新主题行

GmailMessage - 此消息适用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

reply(body)
replyAll(body)
replyAll(body, options)

`replyAll(body)`

使用回复地址以及此邮件的所有收件人回复发件人。电子邮件（包括标头）的大小有配额限制。

// Respond to all recipients (except bcc'd) of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

参数

名称	类型	说明
`body`	`String`	电子邮件的正文。

GmailMessage - 此消息，可用于链式处理。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

reply(body)
reply(body, options)
replyAll(body, options)

`replyAll(body, options)`

使用回复地址及所有收件人（包含可选参数）回复此邮件。

该电子邮件可以包含纯文本和 HTML 正文。电子邮件（包括标头）的大小有配额限制。

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
messageThread.replyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

参数

名称	类型	说明
`body`	`String`	电子邮件的正文。
`options`	`Object`	一个 JavaScript 对象，用于指定高级参数，如下所示。

高级参数

名称	类型	说明
`attachments`	`BlobSource[]`	使用电子邮件发送的一组文件
`bcc`	`String`	密送至电子邮件地址的逗号分隔列表
`cc`	`String`	抄送抄送地址的逗号分隔列表
`from`	`String`	发送电子邮件的地址，必须是 `GmailApp.getAliases()` 返回的值之一
`htmlBody`	`String`	设置后，能够呈现 HTML 的设备会使用它（而非必需的正文参数）；如果您有内嵌的电子邮件图片，则可以在 HTML 正文中添加可选的 `inlineImages` 字段
`inlineImages`	`Object`	一个 JavaScript 对象，包含从图片键 (`String`) 到图片数据 (`BlobSource`) 的映射；此示例假设使用 `htmlBody` 参数并包含对图片的引用（格式为 `<img src="cid:imageKey" />`）
`name`	`String`	电子邮件发件人的姓名（默认：用户姓名）
`noReply`	`Boolean`	如果电子邮件应通过无回复常规电子邮件地址发送，以防止收件人回复电子邮件，请使用 `true`；此选项仅适用于 Google Workspace 帐号，不适用于 Gmail 用户
`replyTo`	`String`	用作默认回复地址的电子邮件地址（默认：用户的电子邮件地址）
`subject`	`String`	电子邮件的新主题行（最多 250 个字符）

GmailMessage - 此消息适用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

reply(body)
reply(body, options)
replyAll(body)

`star()`

为邮件加注星标。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.star(); // Star the message

GmailMessage - 此 GmailMessage，可用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

unstar()

`unstar()`

移除该邮件的星标。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.unstar(); // Unstar the message

GmailMessage - 此 GmailMessage，可用于链接。

授权

使用此方法的脚本需要通过以下范围或相关 REST API 的适当范围进行授权：

https://mail.google.com/

另请参阅

star()