本頁面由 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 的裝置會使用這個程式碼必要的 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.
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 的裝置會使用這個程式碼必要的 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
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 的裝置會使用這個程式碼必要的 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`	如果傳回的 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()`

取得這個訊息的原始內容。等同於「顯示原始郵件」。

回攻員

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：包含這封郵件的 Gmail 討論串。

授權

使用這個方法的指令碼需要授權下列一或多個範圍或相關 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 的裝置會使用這個程式碼必要的 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
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 的裝置會使用這個程式碼必要的 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()`

為郵件加上星號。

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