此页面由 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 的设备会使用它，而不是必需的 body 参数；如果您为电子邮件内嵌了图片，则可以在 HTML 正文中添加可选的 `inlineImages` 字段
`inlineImages`	`Object`	一个 JavaScript 对象，包含从图片键 (`String`) 到图片数据 (`BlobSource`) 的映射；这假定使用了 `htmlBody` 参数，并且包含采用 `<img src="cid:imageKey" />` 格式的这些图片的引用
`name`	`String`	电子邮件发件人的姓名（默认：用户的姓名）
`replyTo`	`String`	要用作默认回复地址的电子邮件地址（默认：用户的电子邮件地址）
`subject`	`String`	电子邮件的新主题行，最多 250 个字符。

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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 的设备会使用它，而不是必需的 body 参数；如果您为电子邮件内嵌了图片，则可以在 HTML 正文中添加可选的 `inlineImages` 字段
`inlineImages`	`Object`	一个 JavaScript 对象，包含从图片键 (`String`) 到图片数据 (`BlobSource`) 的映射；这假定使用了 `htmlBody` 参数，并且包含采用 `<img src="cid:imageKey" />` 格式的这些图片的引用
`name`	`String`	电子邮件发件人的姓名（默认：用户的姓名）
`replyTo`	`String`	要用作默认回复地址的电子邮件地址（默认：用户的电子邮件地址）
`subject`	`String`	电子邮件的新主题行，最多 250 个字符。

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 正文。电子邮件（包括标头）的大小超出了配额限制。

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 的设备会使用它，而不是必需的 body 参数；如果您为电子邮件内嵌了图片，则可以在 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/

另请参阅

forward(recipient)

`getAttachments()`

获取此邮件的所有附件。

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

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

`getAttachments(options)`

获取此邮件的所有附件。

参数

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

高级参数

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

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

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

`getBcc()`

获取此邮件的密送收件人（以英文逗号分隔）。

从定义上讲，所有收到的消息的此字段均为空。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 内容。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()`

获取此邮件的抄送收件人（以英文逗号分隔）。

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

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

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

另请参阅

getTo()

`getDate()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()`

获取此邮件的发件人。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 标头的值。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const 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。

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

String - 邮件 ID。

`getPlainBody()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()`

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

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

String - 回复电子邮件地址。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

另请参阅

getCc()

`getSubject()`

获取此邮件的主题。

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

String - 该邮件的主题。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

另请参阅

getAttachments()

`getThread()`

获取包含此消息的会话。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()`

获取此邮件是否为草稿。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

Boolean - 此邮件是否为草稿。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

`isInChats()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

Boolean - 此消息是否为聊天消息。

`isInInbox()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

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

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

`isInPriorityInbox()`

如果此邮件位于“重要收件箱”中，则返回 true；否则，返回 false。

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let 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()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

Boolean - 此邮件是否位于回收站中。

`isStarred()`

获取此邮件是否已加星标。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

Boolean - 此邮件是否已加星标。

`isUnread()`

获取此消息是否未读。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

Boolean - 此邮件的未读状态。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

`markRead()`

将邮件标记为已读。

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

GmailMessage - 此 GmailMessage，适用于串联。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

另请参阅

isUnread()

`markUnread()`

将邮件标记为未读。

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

GmailMessage - 此 GmailMessage，适用于串联。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

另请参阅

isUnread()

`moveToTrash()`

将邮件移至回收站。

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

GmailMessage - 此 GmailMessage，适用于串联。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

另请参阅

isInTrash()

`refresh()`

从 Gmail 重新加载此邮件及其关联状态（如果标签、已读状态等已更改，此操作非常有用）。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 的设备会使用它，而不是必需的 body 参数；如果您为电子邮件内嵌了图片，则可以在 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)
replyAll(body)
replyAll(body, options)

`replyAll(body)`

使用“回复”地址回复发件人，并抄送此邮件的所有收件人。电子邮件（包括标头）的大小超出了配额限制。

// Respond to all recipients (except bcc'd) of last email in thread with
// acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.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 的设备会使用它，而不是必需的 body 参数；如果您为电子邮件内嵌了图片，则可以在 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()`

为邮件加星标。

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

GmailMessage - 此 GmailMessage，适用于串联。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

另请参阅

unstar()

`unstar()`

为消息移除星标。

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

GmailMessage - 此 GmailMessage，适用于串联。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://mail.google.com/

另请参阅

star()