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`	`true`：傳回的 Blob 附件陣列是否應包含內嵌圖片 (預設為 `true`)。
`includeAttachments`	`Boolean`	`true`：傳回的 Blob 附件陣列是否應包含一般 (非內嵌) 附件 (預設為 `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 - This message for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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()`