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

参数

名称类型说明
threadGmailThread要加标签的会话。

弃踢回攻

GmailLabel - 此标签,用于串联。

授权

使用此方法的脚本需要获得以下一个或多个范围相关 REST API 的适当范围的授权:

  • https://mail.google.com/

另请参阅


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

参数

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

弃踢回攻

GmailLabel - 此标签,用于串联。

授权

使用此方法的脚本需要获得以下一个或多个范围相关 REST API 的适当范围的授权:

  • https://mail.google.com/

另请参阅


deleteLabel()

删除此标签。

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

抛出

Error - 如果无法删除标签

授权

使用此方法的脚本需要获得以下一个或多个范围相关 REST API 的适当范围的授权:

  • https://mail.google.com/

另请参阅


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

参数

名称类型说明
startInteger起始线程的索引。
maxInteger要返回的最大线程数。

弃踢回攻

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

参数

名称类型说明
threadGmailThread未给会话添加标签。

弃踢回攻

GmailLabel - 此标签,用于串联。

授权

使用此方法的脚本需要获得以下一个或多个范围相关 REST API 的适当范围的授权:

  • https://mail.google.com/

另请参阅


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

参数

名称类型说明
threadsGmailThread[]一组未加标签的线程。

弃踢回攻

GmailLabel - 此标签,用于串联。

授权

使用此方法的脚本需要获得以下一个或多个范围相关 REST API 的适当范围的授权:

  • https://mail.google.com/

另请参阅