Class GmailMessage

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");

参数

名称类型说明
bodyString电子邮件的正文。

弃踢回攻

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

参数

名称类型说明
bodyString电子邮件的正文。
optionsObject一个用于指定高级参数的 JavaScript 对象,如下所示。

高级参数

名称类型说明
attachmentsBlobSource[]要随电子邮件发送的文件数组
bccString要密送至的一系列电子邮件地址(以英文逗号分隔)
ccString要抄送的电子邮件地址的逗号分隔列表
fromString发送电子邮件时应使用的地址,必须是 GmailApp.getAliases() 返回的值之一
htmlBodyString设置后,能够呈现 HTML 的设备将使用它,而不是必需的正文参数;如果您有用于电子邮件的内嵌图片,则可以在 HTML 正文中添加可选的 inlineImages 字段
inlineImagesObject一个 JavaScript 对象,其中包含从图片键 (String) 到图片数据 (BlobSource) 的映射;这假定使用 htmlBody 参数,并包含对 <img src="cid:imageKey" /> 格式这些图片的引用
nameString电子邮件发件人的姓名(默认值:用户的姓名)
replyToString用作默认回复地址的电子邮件地址(默认:用户的电子邮件地址)
subjectString电子邮件的新主题行,最多 250 个字符。

弃踢回攻

GmailDraft - 新创建的邮件草稿。

授权

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

  • https://mail.google.com/

另请参阅


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");

参数

名称类型说明
bodyString电子邮件的正文。

弃踢回攻

GmailDraft - 新创建的邮件草稿。

授权

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

  • https://mail.google.com/

另请参阅


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

参数

名称类型说明
bodyString电子邮件的正文。
optionsObject一个用于指定高级参数的 JavaScript 对象,如下所示。

高级参数

名称类型说明
attachmentsBlobSource[]要随电子邮件发送的文件数组
bccString要密送至的一系列电子邮件地址(以英文逗号分隔)
ccString要抄送的电子邮件地址的逗号分隔列表
fromString发送电子邮件时应使用的地址,必须是 GmailApp.getAliases() 返回的值之一
htmlBodyString设置后,能够呈现 HTML 的设备将使用它,而不是必需的正文参数;如果您有用于电子邮件的内嵌图片,则可以在 HTML 正文中添加可选的 inlineImages 字段
inlineImagesObject一个 JavaScript 对象,其中包含从图片键 (String) 到图片数据 (BlobSource) 的映射;这假定使用 htmlBody 参数,并包含对 <img src="cid:imageKey" /> 格式这些图片的引用
nameString电子邮件发件人的姓名(默认值:用户的姓名)
replyToString用作默认回复地址的电子邮件地址(默认:用户的电子邮件地址)
subjectString电子邮件的新主题行,最多 250 个字符。

弃踢回攻

GmailDraft - 新创建的邮件草稿。

授权

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

  • https://mail.google.com/

另请参阅


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");

参数

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

弃踢回攻

GmailMessage - 此消息,可用于链接。

授权

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

  • https://mail.google.com/

另请参阅


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

参数

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

高级参数

名称类型说明
attachmentsBlobSource[]要随电子邮件发送的文件数组
bccString要密送至的一系列电子邮件地址(以英文逗号分隔)
ccString要抄送的电子邮件地址的逗号分隔列表
fromString发送电子邮件时应使用的地址,必须是 GmailApp.getAliases() 返回的值之一
htmlBodyString设置后,能够呈现 HTML 的设备将使用它,而不是必需的正文参数;如果您有用于电子邮件的内嵌图片,则可以在 HTML 正文中添加可选的 inlineImages 字段
inlineImagesObject一个 JavaScript 对象,其中包含从图片键 (String) 到图片数据 (BlobSource) 的映射;这假定使用 htmlBody 参数,并包含对 <img src="cid:imageKey" /> 格式这些图片的引用
nameString电子邮件发件人的姓名(默认值:用户的姓名)
noReplyBoolean如果电子邮件应通过无回复的通用电子邮件地址发送,则为 true,以防止收件人回复电子邮件;此选项仅适用于 Google Workspace 账号,不适用于 Gmail 用户
replyToString用作默认回复地址的电子邮件地址(默认:用户的电子邮件地址)
subjectString电子邮件的新主题行,最多 250 个字符。

弃踢回攻

GmailMessage - 此消息,可用于链接。

授权

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

  • https://mail.google.com/

另请参阅


getAttachments()

获取该邮件的所有附件。

弃踢回攻

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

授权

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

  • https://mail.google.com/

getAttachments(options)

获取该邮件的所有附件。

参数

名称类型说明
optionsObject一个用于指定高级参数的 JavaScript 对象,如下所示。

高级参数

名称类型说明
includeInlineImagesBoolean如果返回的 Blob 附件数组应包含内嵌图片,则返回 true(默认值为 true)。
includeAttachmentsBoolean如果返回的 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/

另请参阅


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/

另请参阅


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/

另请参阅


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/

另请参阅


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.

参数

名称类型说明
nameStringRFC 标头的名称,没有将其与值分隔开来的冒号。

弃踢回攻

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/

另请参阅


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/

另请参阅


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/

另请参阅


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/

另请参阅


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/

另请参阅


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/

另请参阅


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/

另请参阅


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");

参数

名称类型说明
bodyString电子邮件的正文。

弃踢回攻

GmailMessage - 此消息,可用于链接。

授权

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

  • https://mail.google.com/

另请参阅


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

参数

名称类型说明
bodyString电子邮件的正文。
optionsObject一个用于指定高级参数的 JavaScript 对象,如下所示。

高级参数

名称类型说明
attachmentsBlobSource[]要随电子邮件发送的文件数组
bccString要密送至的一系列电子邮件地址(以英文逗号分隔)
ccString要抄送的电子邮件地址的逗号分隔列表
fromString发送电子邮件时应使用的地址,必须是 GmailApp.getAliases() 返回的值之一
htmlBodyString设置后,能够呈现 HTML 的设备将使用它,而不是必需的正文参数;如果您有用于电子邮件的内嵌图片,则可以在 HTML 正文中添加可选的 inlineImages 字段
inlineImagesObject一个 JavaScript 对象,其中包含从图片键 (String) 到图片数据 (BlobSource) 的映射;这假定使用 htmlBody 参数,并包含对 <img src="cid:imageKey" /> 格式这些图片的引用
nameString电子邮件发件人的姓名(默认值:用户的姓名)
noReplyBoolean如果电子邮件应通过无回复的通用电子邮件地址发送,则为 true,以防止收件人回复电子邮件;此选项仅适用于 Google Workspace 账号,不适用于 Gmail 用户
replyToString用作默认回复地址的电子邮件地址(默认:用户的电子邮件地址)
subjectString电子邮件的新主题行,最多 250 个字符。

弃踢回攻

GmailMessage - 此消息,可用于链接。

授权

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

  • https://mail.google.com/

另请参阅


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");

参数

名称类型说明
bodyString电子邮件的正文。

弃踢回攻

GmailMessage - 此消息,用于链接。

授权

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

  • https://mail.google.com/

另请参阅


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

参数

名称类型说明
bodyString电子邮件的正文。
optionsObject一个用于指定高级参数的 JavaScript 对象,如下所示。

高级参数

名称类型说明
attachmentsBlobSource[]要随电子邮件发送的文件数组
bccString要密送至的一系列电子邮件地址(以英文逗号分隔)
ccString要抄送的电子邮件地址的逗号分隔列表
fromString发送电子邮件时应使用的地址,必须是 GmailApp.getAliases() 返回的值之一
htmlBodyString设置后,能够呈现 HTML 的设备将使用它,而不是必需的正文参数;如果您有用于电子邮件的内嵌图片,则可以在 HTML 正文中添加可选的 inlineImages 字段
inlineImagesObject一个 JavaScript 对象,其中包含从图片键 (String) 到图片数据 (BlobSource) 的映射;这假定使用 htmlBody 参数,并包含对 <img src="cid:imageKey" /> 格式这些图片的引用
nameString电子邮件发件人的姓名(默认值:用户的姓名)
noReplyBoolean如果电子邮件应通过无回复的通用电子邮件地址发送,则为 true,以防止收件人回复电子邮件;此选项仅适用于 Google Workspace 账号,不适用于 Gmail 用户
replyToString用作默认回复地址的电子邮件地址(默认:用户的电子邮件地址)
subjectString电子邮件的新主题行,最多 250 个字符。

弃踢回攻

GmailMessage - 此消息,可用于链接。

授权

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

  • https://mail.google.com/

另请参阅


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()

为邮件移除星标。

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/

另请参阅