Class GmailLabel

Gmail标签

用户在自己的 Gmail 账号中创建的标签。

方法

方法	返回类型	简介
addToThread(thread)	GmailLabel	将此标签添加到指定线程，并强制线程刷新 (GmailThread.refresh())。
addToThreads(threads)	GmailLabel	将此标签添加到指定线程，并强制线程刷新。
deleteLabel()	void	删除此标签。
getId()	String	获取相应标签的 ID。
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);

参数

名称	类型	说明
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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.addToThreads(threads);

参数

名称	类型	说明
threads	GmailThread[]	要添加标签的线程数组。

返回

GmailLabel - 此标签，用于链式调用。

授权

使用此方法的脚本需要通过以下一个或多个范围或相关 REST API 中的相应范围进行授权：

• https://mail.google.com/

另请参阅

• removeFromThreads(threads)

---

deleteLabel()

删除此标签。

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

抛出

Error - 如果无法删除标签

授权

使用此方法的脚本需要通过以下一个或多个范围或相关 REST API 中的相应范围进行授权：

• https://mail.google.com/

另请参阅

• getName()

---

getId()

获取相应标签的 ID。

const label = GmailApp.getUserLabelByName('MyLabel');
console.log(label.getId());

返回

String - 标签的 ID。

授权

使用此方法的脚本需要通过以下一个或多个范围或相关 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());
}

参数

名称	类型	说明
start	Integer	起始线程的索引。
max	Integer	要返回的线程数量上限。

返回

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);

参数

名称	类型	说明
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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.removeFromThreads(threads);

参数

名称	类型	说明
threads	GmailThread[]	要取消标签的会话串数组。

返回

GmailLabel - 此标签，用于链式调用。

授权

使用此方法的脚本需要通过以下一个或多个范围或相关 REST API 中的相应范围进行授权：

• https://mail.google.com/

另请参阅

• addToThreads(threads)