Class GmailLabel

Gmail標籤

使用者在 Gmail 帳戶中建立的標籤。

方法

方法傳回類型簡短說明
addToThread(thread)GmailLabel將這個標籤新增至指定的執行緒，並強制執行緒重新整理 (GmailThread.refresh())。
addToThreads(threads)GmailLabel將此標籤新增至指定的執行緒，並強制執行緒重新整理。
deleteLabel()void刪除這個標籤。
getName()String取得此標籤的名稱。
getThreads()GmailThread[]取得標有此標籤的執行緒。
getThreads(start, max)GmailThread[]取得標示為此標籤的執行緒範圍。
getUnreadCount()Integer取得標有此標籤的未讀會話串數量。
removeFromThread(thread)GmailLabel從指定的執行緒中移除此標籤，並強制執行緒重新整理。
removeFromThreads(threads)GmailLabel從指定的執行緒中移除此標籤，並強制執行緒重新整理。

內容詳盡的說明文件

addToThread(thread)

將這個標籤新增至指定的執行緒，並強制執行緒重新整理 (GmailThread.refresh())。

// label the first thread in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.addToThread(firstThread);

參數

名稱類型說明
threadGmailThread要標示的執行緒。

回攻員

GmailLabel：這個標籤用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

另請參閱

addToThreads(threads)

將此標籤新增至指定的執行緒，並強制執行緒重新整理。您最多可為每批次 100 個執行緒新增標籤。

// label the first three threads in the inbox with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.addToThreads(threads);

參數

名稱類型說明
threadsGmailThread[]要標示的執行緒陣列。

回攻員

GmailLabel：這個標籤用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

另請參閱

deleteLabel()

刪除這個標籤。 

const label = GmailApp.getUserLabelByName('MyLabel');
label.deleteLabel();

擲回

Error：如果標籤無法刪除

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

另請參閱

getName()

取得此標籤的名稱。

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

回攻員

String：標籤的名稱。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

getThreads()

取得標有此標籤的執行緒。

如果所有執行緒的大小過大，系統無法處理，這項呼叫就會失敗。如果執行緒大小不明且可能非常大，請使用 getThreads(start, max)，並指定要在每個呼叫中擷取的執行緒範圍。

// Log the subject lines of the threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

回攻員

GmailThread[]：標示為此標籤的執行緒陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

getThreads(start, max)

取得標示為此標籤的執行緒範圍。

// log the subject lines of up to the first 30 threads with the label MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads(0, 30);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

參數

名稱類型說明
startInteger起始執行緒的索引。
maxInteger要傳回的執行緒數量上限。

回攻員

GmailThread[]：標示為此標籤的執行緒陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

getUnreadCount()

取得標有此標籤的未讀會話串數量。

// log the number of unread threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getUnreadCount());

回攻員

Integer：未讀取的標記討論串數量。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

removeFromThread(thread)

從指定的執行緒中移除此標籤，並強制執行緒重新整理。

// remove the label MyLabel from the first thread in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.removeFromThread(firstThread);

參數

名稱類型說明
threadGmailThread該執行緒未標示。

回攻員

GmailLabel：這個標籤用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

另請參閱

removeFromThreads(threads)

從指定的執行緒中移除此標籤，並強制執行緒重新整理。每批最多可移除 100 個執行緒的標記。

// remove the label MyLabel from the first three threads in the inbox
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.removeFromThreads(threads);

參數

名稱類型說明
threadsGmailThread[]要標示的執行緒陣列。

回攻員

GmailLabel：這個標籤用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權，或是相關 REST API 中的適當範圍：

  • https://mail.google.com/

另請參閱