Class GmailThread

GmailThread

使用者 Gmail 帳戶中的討論串。

方法

方法傳回類型簡短說明
addLabel(label)GmailThread將這個標籤加到討論串。
createDraftReply(body)GmailDraft使用 。
createDraftReply(body, options)GmailDraft使用 回覆地址,含選用引數。
createDraftReplyAll(body)GmailDraft使用 回覆地址和這封郵件的所有收件者。
createDraftReplyAll(body, options)GmailDraft使用 回覆地址和所有收件者,並使用選用的引數。
getFirstMessageSubject()String取得討論串中第一則訊息的主旨。
getId()String取得這個執行緒的 ID。
getLabels()GmailLabel[]傳回使用者在這個討論串中建立的標籤。
getLastMessageDate()Date取得這個討論串的最新訊息日期。
getMessageCount()Integer傳回會話串中的訊息數量。
getMessages()GmailMessage[]取得這個討論串中的訊息。
getPermalink()String取得這個執行緒的永久連結。
hasStarredMessages()Boolean傳回討論串是否有已加星號的郵件。
isImportant()Boolean傳回討論串是否標示為重要。
isInChats()Boolean傳回討論串是否為即時通訊加上標籤。
isInInbox()Boolean傳回討論串是否在收件匣中。
isInPriorityInbox()Boolean如果這個討論串位於優先收件匣,則傳回 true;否則會傳回 false。
isInSpam()Boolean傳回討論串是否標示為垃圾內容。
isInTrash()Boolean傳回討論串是否在垃圾桶中。
isUnread()Boolean傳回討論串是否有未讀郵件。
markImportant()GmailThread將這個討論串標示為重要。
markRead()GmailThread將這個討論串標示為已讀取。
markUnimportant()GmailThread將這個討論串標示為不重要。
markUnread()GmailThread已將這個討論串標示為未讀取。
moveToArchive()GmailThread將這個討論串移至封存。
moveToInbox()GmailThread將這個討論串移至收件匣。
moveToSpam()GmailThread將這個討論串移至垃圾內容。
moveToTrash()GmailThread將這個討論串移至垃圾桶。
refresh()GmailThread從 Gmail 重新載入這個討論串及相關狀態 (在標籤、讀取狀態、 等)。
removeLabel(label)GmailThread從討論串中移除這個標籤。
reply(body)GmailThread使用 responseTo 地址回覆這個討論串中最後一則訊息的寄件者。
reply(body, options)GmailThread使用 responseTo 地址回覆這個討論串上最後一則訊息的寄件者,並視需要回覆 引數。
replyAll(body)GmailThread回覆寄件者 (使用 ReplyTo 地址),以及這封信上最後一封郵件的所有收件者 。
replyAll(body, options)GmailThread回覆寄件者 (使用 replyTo 地址),以及最後一封郵件的所有收件者 搭配選用引數

內容詳盡的說明文件

addLabel(label)

將這個標籤加到討論串。

// Add label MyLabel to the first thread in the inbox
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.addLabel(label);

參數

名稱類型說明
labelGmailLabel要套用至這個討論串的標籤

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


createDraftReply(body)

使用 。電子郵件 (包括標頭) 的大小有限

// Create a draft reply to the message author with an acknowledgement.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.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];
firstThread.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 的裝置會改用這個程式碼 所需的 body 引數之一;您可以視需要在 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 reply to all recipients (except those bcc'd) of the last email in this
// thread.
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 reply, using an HTML text body, to all recipients (except those bcc'd) of
// the last email of in this thread.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.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 的裝置會改用這個程式碼 所需的 body 引數之一;您可以視需要在 HTML 中新增 inlineImages 欄位 電子郵件內文 (如果電子郵件含有內嵌圖片)
inlineImagesObject包含來自圖片鍵對應的 JavaScript 物件 (String) 轉換為圖片資料 (BlobSource);此情況假設使用 htmlBody 參數,且包含這些圖片的參照,格式為 <img src="cid:imageKey" />
nameString電子郵件寄件者的名稱 (預設:使用者名稱)
replyToString設為預設回覆地址的電子郵件地址 (預設:使用者的電子郵件地址)
subjectString電子郵件的新主旨行長度上限為 250 個半形字元。

回攻員

GmailDraft:新建立的訊息草稿

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


getFirstMessageSubject()

取得討論串中第一則訊息的主旨。

// Log the subject of the first message in the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getFirstMessageSubject());

回攻員

String:討論串中第一則訊息的主旨

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


getId()

取得這個執行緒的 ID。會話串的 ID 會根據其中包含的訊息而有所不同;的 執行緒中特定訊息的一致 ID,並呼叫 getMessages()[0].getId()

// Log the subject of the first message in the first thread in the inbox.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var id = firstThread.getId();
// Get same thread by its ID.
var thread = GmailApp.getThreadById(id);
Logger.log(thread.getFirstMessageSubject() == firstThread.getFirstMessageSubject()); // True

回攻員

String:這個執行緒的 ID


getLabels()

傳回使用者在這個討論串中建立的標籤。

// Log the names of the labels attached to the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var labels = firstThread.getLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log(labels[i].getName());
}

回攻員

GmailLabel[]:這個討論串的標籤陣列

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

getLastMessageDate()

取得這個討論串的最新訊息日期。

// Log the date of the most recent message on the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getLastMessageDate());

回攻員

Date:討論串中最新郵件的日期

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


getMessageCount()

傳回會話串中的訊息數量。

// Log the number of messages in the thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(firstThread.getMessageCount());

回攻員

Integer:討論串中的訊息數量

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


getMessages()

取得這個討論串中的訊息。

// Log the subjects of the messages in the thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
for (var i = 0; i < messages.length; i++) {
  Logger.log(messages[i].getSubject());
}

回攻員

GmailMessage[]:這個討論串中的 Gmail 郵件陣列

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


取得這個執行緒的永久連結。

請注意,這個方法僅適用於傳統版 Gmail 介面,不適用於收件匣。

// Logs the permalink for the first thread in the inbox
var thread = GmailApp.getInboxThreads(0,1)[0];
Logger.log(thread.getPermalink());

回攻員

String:這個執行緒的永久連結


hasStarredMessages()

傳回討論串是否有已加星號的郵件。

// Log if this thread has starred messages
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('has starred : ' + firstThread.hasStarredMessages());

回攻員

Boolean:如果討論串有任何已加星號的訊息,則傳回 true

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

isImportant()

傳回討論串是否標示為重要。

// Log if this thread is marked as important
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Important? : ' + firstThread.isImportant());

回攻員

Boolean:討論串是否標示為重要。

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

isInChats()

傳回討論串是否為即時通訊加上標籤。

// Log if this thread is a chat
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('is in chats? : ' + firstThread.isInChats());

回攻員

Boolean:如果討論串有標籤,則為 true

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

isInInbox()

傳回討論串是否在收件匣中。

// Log if this thread is in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('is in the inbox? : ' + firstThread.isInInbox());

回攻員

Boolean:如果討論串在收件匣中,則為 true

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

isInPriorityInbox()

如果這個討論串位於優先收件匣,則傳回 true;否則會傳回 false。

// Log if this thread is in the priority inbox
var firstThread = GmailApp.getPriorityInboxThreads(0,1)[0];
Logger.log("is in priority inbox? " + firstThread.isInPriorityInbox());

回攻員

Boolean:如果討論串位於優先收件匣,則為 true

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

isInSpam()

傳回討論串是否標示為垃圾內容。

// Log if this thread is in the spam folder
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Spam? ' + firstThread.isInSpam());

回攻員

Boolean - 這個討論串是否標示為垃圾內容。

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

isInTrash()

傳回討論串是否在垃圾桶中。

// Log if this thread is in the trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Trashed? ' + firstThread.isInTrash());

回攻員

Boolean:如果討論串位於垃圾桶中,則傳回 true

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

isUnread()

傳回討論串是否有未讀郵件。

// Log if this thread is unread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
Logger.log('Unread? ' + firstThread.isUnread());

回攻員

Boolean — 如果有未讀郵件,則為 true

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

markImportant()

將這個討論串標示為重要。

// Mark first inbox thread as important
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markImportant();

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


markRead()

將這個討論串標示為已讀取。

// Mark first inbox thread as read
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markRead();

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


markUnimportant()

將這個討論串標示為不重要。

// Mark first inbox thread as unimportant
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markUnimportant();

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


markUnread()

已將這個討論串標示為未讀取。

// Mark first inbox thread as unread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.markUnread();

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


moveToArchive()

將這個討論串移至封存。

// Archive first inbox thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.moveToArchive();

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

moveToInbox()

將這個討論串移至收件匣。

// Move first non-inbox thread to inbox
var firstThread = GmailApp.search("-in:inbox")[0];
firstThread.moveToInbox();

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

moveToSpam()

將這個討論串移至垃圾內容。

// Move first inbox thread to spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.moveToSpam();

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

moveToTrash()

將這個討論串移至垃圾桶。

// Move first inbox thread to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.moveToTrash();

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

refresh()

從 Gmail 重新載入這個討論串及相關狀態 (在標籤、讀取狀態、 等)。

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
firstThread.refresh(); // Make sure it's up-to-date
// ...Do more stuff with firstThread ...

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

removeLabel(label)

從討論串中移除這個標籤。

var myLabel = GmailApp.getUserLabelByName('<your label>');
var threads = myLabel.getThreads();
for (var x in threads) {
  var thread = threads[x];
  thread.removeLabel(myLabel);
}

參數

名稱類型說明
labelGmailLabel要從這個討論串移除的標籤

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


reply(body)

使用 responseTo 地址回覆這個討論串中最後一則訊息的寄件者。

請注意,電子郵件的總大小 (包括所有標頭) 不得超過 20 KB。

// Respond to author of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.reply("Got your message");

參數

名稱類型說明
bodyString電子郵件內文

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


reply(body, options)

使用 responseTo 地址回覆這個討論串上最後一則訊息的寄件者,並視需要回覆 引數。電子郵件可包含純文字和 HTML 內文。請注意 電子郵件的大小 (包括所有標頭,但不包括附件) 不得超過 20 KB。

// Respond with HTML body text.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.reply("incapable of HTML", {
  htmlBody: "some HTML body text",
  noReply: true
});

參數

名稱類型說明
bodyString電子郵件內文
optionsObject指定進階參數的 JavaScript 物件,如下所示

進階參數

名稱類型說明
ccString列出要接收副本的電子郵件地址,以半形逗號分隔
bccString以逗號分隔的密件副本電子郵件地址清單
htmlBodyString設定後,能夠轉譯 HTML 的裝置會改用這個程式碼 所需的 body 引數之一;您可以視需要在 HTML 中新增 inlineImages 欄位 電子郵件內文 (如果電子郵件含有內嵌圖片)
nameString電子郵件寄件者的名稱 (預設:使用者名稱)
fromString電子郵件的寄件地址 (必須是一個地址) 符合 GmailApp.getAliases() 所傳回值的百分比
replyToString設為預設回覆地址的電子郵件地址 (預設:使用者的電子郵件地址)
noReplyBooleantrue 如果應從一般電子郵件寄出 請勿回覆電子郵件,勸阻收件者回覆電子郵件。這個選項 僅適用於 Google Workspace 帳戶,Gmail 使用者
attachmentsBlobSource[]換 要隨電子郵件傳送的檔案陣列
inlineImagesObject包含來自圖片鍵對應的 JavaScript 物件 (String) 轉換為圖片資料 (BlobSource);此情況假設使用 htmlBody 參數,且包含這些圖片的參照,格式為 <img src="cid:imageKey" />

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


replyAll(body)

回覆寄件者 (使用 ReplyTo 地址),以及這封信上最後一封郵件的所有收件者 。

請注意,電子郵件的總大小 (包括所有標頭) 不得超過 20 KB。

// Respond to all with acknowledgment to the first thread in the inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.replyAll("Got your message");

參數

名稱類型說明
bodyString電子郵件內文

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱


replyAll(body, options)

回覆寄件者 (使用 replyTo 地址),以及最後一封郵件的所有收件者 搭配選用引數電子郵件可包含純文字和 HTML 內文。請注意,電子郵件的總大小 (包括所有標頭,但不包括 附件) 不得超過 20 KB。

// Respond with HTML body text.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
firstThread.replyAll("incapable of HTML", {
  htmlBody: "some HTML body text",
  noReply: true
});

參數

名稱類型說明
bodyString電子郵件內文
optionsObject指定進階參數的 JavaScript 物件,如下所示

進階參數

名稱類型說明
ccString列出要接收副本的電子郵件地址,以半形逗號分隔
bccString以逗號分隔的密件副本電子郵件地址清單
htmlBodyString設定後,能夠轉譯 HTML 的裝置會改用這個程式碼 所需的 body 引數之一;您可以視需要在 HTML 中新增 inlineImages 欄位 電子郵件內文 (如果電子郵件含有內嵌圖片)
nameString電子郵件寄件者的名稱 (預設:使用者名稱)
fromString電子郵件的寄件地址 (必須是一個地址) 符合 GmailApp.getAliases() 所傳回值的百分比
replyToString設為預設回覆地址的電子郵件地址 (預設:使用者的電子郵件地址)
noReplyBooleantrue 如果應從一般電子郵件寄出 請勿回覆電子郵件,勸阻收件者回覆電子郵件。這個選項 僅適用於 G Suite 帳戶,Gmail 使用者
attachmentsBlobSource[]換 要隨電子郵件傳送的檔案陣列
inlineImagesObject包含來自圖片鍵對應的 JavaScript 物件 (String) 轉換為圖片資料 (BlobSource);此情況假設使用 htmlBody 參數,且包含這些圖片的參照,格式為 <img src="cid:imageKey" />

回攻員

GmailThread:這個執行緒對鏈結非常實用

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

  • https://mail.google.com/

另請參閱