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 欄位
inlineImagesObjectJavaScript 物件,包含圖片索引鍵 (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 欄位
inlineImagesObjectJavaScript 物件,包含圖片索引鍵 (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 欄位
inlineImagesObjectJavaScript 物件,包含圖片索引鍵 (String) 與圖片資料 (BlobSource) 的對應。這裡假設使用的是 htmlBody 參數,且包含這些圖片的參照 (格式為 <img src="cid:imageKey" />)
nameString電子郵件寄件者的名稱 (預設值:使用者名稱)
noReplyBooleantrue如果電子郵件應透過一般無回覆的電子郵件地址傳送,以免收件者不想回覆電子郵件;這個選項僅適用於 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 物件,如下所示。

進階參數

名稱類型說明
includeInlineImagesBooleantrue如果 Blob 附件的傳回的陣列應包含內嵌圖片 (預設值為 true)。
includeAttachmentsBooleantrue:如果 Blob 附件的陣列應包含一般 (非內嵌) 附件,則為 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 欄位
inlineImagesObjectJavaScript 物件,包含圖片索引鍵 (String) 與圖片資料 (BlobSource) 的對應。這裡假設使用的是 htmlBody 參數,且包含這些圖片的參照 (格式為 <img src="cid:imageKey" />)
nameString電子郵件寄件者的名稱 (預設值:使用者名稱)
noReplyBooleantrue如果電子郵件應透過一般無回覆的電子郵件地址傳送,以免收件者不想回覆電子郵件;這個選項僅適用於 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 欄位
inlineImagesObjectJavaScript 物件,包含圖片索引鍵 (String) 與圖片資料 (BlobSource) 的對應。這裡假設使用的是 htmlBody 參數,且包含這些圖片的參照 (格式為 <img src="cid:imageKey" />)
nameString電子郵件寄件者的名稱 (預設值:使用者名稱)
noReplyBooleantrue如果電子郵件應透過一般無回覆的電子郵件地址傳送,以免收件者不想回覆電子郵件;這個選項僅適用於 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/

另請參閱