本頁面由 Cloud Translation API 翻譯而成。

Class GmailLabel

使用者在 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
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
label.addToThread(firstThread);

參數

名稱	類型	說明
`thread`	`GmailThread`	要加上標籤的討論串。

回攻員

GmailLabel — 這個標籤用於鏈結。

授權

使用這個方法的指令碼必須取得下列一或多個範圍 (或相關的 REST API) 的適當範圍授權：

https://mail.google.com/

另請參閱

removeFromThread(thread)

`addToThreads(threads)`

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

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

參數

名稱	類型	說明
`threads`	`GmailThread[]`	要加上標籤的執行緒陣列。

回攻員

GmailLabel — 這個標籤用於鏈結。

授權

使用這個方法的指令碼必須取得下列一或多個範圍 (或相關的 REST API) 的適當範圍授權：

https://mail.google.com/

另請參閱

removeFromThreads(threads)

`deleteLabel()`

刪除這個標籤。

var label = GmailApp.getUserLabelByName("MyLabel");
label.deleteLabel();

擲回

Error - 如果無法刪除標籤

授權

使用這個方法的指令碼必須取得下列一或多個範圍 (或相關的 REST API) 的適當範圍授權：

https://mail.google.com/

另請參閱

getName()

`getName()`

取得這個標籤的名稱。

var 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads();
for (var 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads(0, 30);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

參數

名稱	類型	說明
`start`	`Integer`	起始執行緒的索引。
`max`	`Integer`	要傳回的執行緒數量上限。

回攻員

GmailThread[] — 加上此標籤的執行緒陣列。

授權

使用這個方法的指令碼必須取得下列一或多個範圍 (或相關的 REST API) 的適當範圍授權：

https://mail.google.com/

`getUnreadCount()`

取得加上此標籤的未讀取討論串數量。

// log the number of unread threads labeled with MyLabel
var 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
var label = GmailApp.getUserLabelByName("MyLabel");
var firstThread = GmailApp.getInboxThreads(0,1)[0];
label.removeFromThread(firstThread);

參數

名稱	類型	說明
`thread`	`GmailThread`	取消為討論串加上標籤。

回攻員

GmailLabel — 這個標籤用於鏈結。

授權

使用這個方法的指令碼必須取得下列一或多個範圍 (或相關的 REST API) 的適當範圍授權：

https://mail.google.com/

另請參閱

addToThread(thread)

`removeFromThreads(threads)`

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

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

參數

名稱	類型	說明
`threads`	`GmailThread[]`	要取消標籤的執行緒陣列。

回攻員

GmailLabel — 這個標籤用於鏈結。

授權

使用這個方法的指令碼必須取得下列一或多個範圍 (或相關的 REST API) 的適當範圍授權：

https://mail.google.com/

另請參閱

addToThreads(threads)