Class GmailLabel

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)