Class GmailMessage

Gmail訊息

使用者 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/

另請參閱

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

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: '[e-mail]',
});

參數

名稱	類型	說明
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: '[e-mail]',
});

參數

名稱	類型	說明
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('[e-mail],[e-mail]');

參數

名稱	類型	說明
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('[e-mail],[e-mail]', {
  cc: '[e-mail]',
  bcc: '[e-mail],[e-mail]',
});

參數

名稱	類型	說明
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	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：用於鏈結的訊息。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 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()