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 的设备会使用此参数，而不是必需的正文实参；如果电子邮件包含内嵌图片，您可以在 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 的设备会使用此参数，而不是必需的正文实参；如果电子邮件包含内嵌图片，您可以在 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 的设备会使用此参数，而不是必需的正文实参；如果电子邮件包含内嵌图片，您可以在 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`	如果返回的 Blob 附件数组应包含内嵌图片，则为 `true`（默认值为 `true`）。`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 的设备会使用此参数，而不是必需的正文实参；如果电子邮件包含内嵌图片，您可以在 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 的设备会使用此参数，而不是必需的正文实参；如果电子邮件包含内嵌图片，您可以在 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()

Class GmailMessage 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

方法

详细文档

createDraftReply(body)

参数

返回

授权

另请参阅

createDraftReply(body, options)

参数

高级参数

返回

授权

另请参阅

createDraftReplyAll(body)

参数

返回

授权

另请参阅

createDraftReplyAll(body, options)

参数

高级参数

返回

授权

另请参阅

forward(recipient)

参数

返回

授权

另请参阅

forward(recipient, options)

参数

高级参数

返回

授权

另请参阅

getAttachments()

返回

授权

getAttachments(options)

参数

高级参数

返回

授权

getBcc()

返回

授权

另请参阅

getBody()

返回

授权

另请参阅

getCc()

返回

授权

另请参阅

getDate()

返回

授权

getFrom()

返回

授权

另请参阅

getHeader(name)

参数

返回

授权

getId()

返回

getPlainBody()

返回

授权

另请参阅

getRawContent()

返回

授权

getReplyTo()

返回

授权

另请参阅

Class GmailMessage

`createDraftReply(body)`

`createDraftReply(body, options)`

`createDraftReplyAll(body)`

`createDraftReplyAll(body, options)`

`forward(recipient)`

`forward(recipient, options)`

`getAttachments()`

`getAttachments(options)`

`getBcc()`

`getBody()`

`getCc()`

`getDate()`

`getFrom()`

`getHeader(name)`

`getId()`

`getPlainBody()`

`getRawContent()`

`getReplyTo()`

`getSubject()`

`getThread()`

`getTo()`

`isDraft()`

`isInChats()`

`isInInbox()`

`isInPriorityInbox()`

`isInTrash()`

`isStarred()`

`isUnread()`

`markRead()`

`markUnread()`

`moveToTrash()`

`refresh()`

`reply(body)`

`reply(body, options)`

`replyAll(body)`

`replyAll(body, options)`

`star()`