Googleを追いかけろ！

.
home >> Gmail Services >> Class GmailLabel

参照ページ(Goolge)


WWW を検索 Googleを追いかけろ！ を検索
class GmailLabel : Members
memberType説明
addToThreadGmailLabel指定されたスレッドにラベルを適用する
addToThreadsGmailLabel指定された複数スレッドにラベルを適用する
removeFromThreadGmailLabel特定のスレッドのラベルを削除する
removeFromThreadsGmailLabel特定の複数スレッドのラベルを削除する
deleteLabelラベルを削除する
getNameStringラベル名を取得する
getThreadsGmailThread[ ]このラベルでマークされたスレッドを取得する
getThreadsGmailThread[ ]このラベルでマークされたスレッドの範囲を取得する
getUnreadCountintこのラベルでマークされた未読スレッドを取得する

addToThread

  • 指定されたスレッドにラベルを適用する

    参考；removeFromThread

Arguments :
nameType説明
threadGmailThread ラベルを適用されるスレッド
戻り値 :
Type説明
GmailLabel 追加または削除されるラベル（連結時に有効）
サンプル :
// 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);

addToThreads(threads)

  • 指定された複数スレッドにラベルを適用する

    参考；removeFromThreads

Arguments :
nameType説明
threadsGmailThread[ ] ラベルを適用される複数スレッド
戻り値 :
Type説明
GmailLabel 追加または削除されるラベル（連結時に有効）
サンプル :
// 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);

removeFromThread(thread)

  • 特定のスレッドのラベルを削除する

    参考；addToThread

Arguments :
nameType説明
threadGmailThread 削除されるスレッドのラベル
戻り値 :
Type説明
GmailLabel 追加または削除されるラベル（連結時に有効）
サンプル :
// 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);

removeFromThreads(threads)

  • 特定の複数スレッドのラベルを削除する

    参考；addToThreads

Arguments :
nameType説明
threadsGmailThread[ ] 削除される複数スレッドのラベル
戻り値 :
Type説明
GmailLabel 追加または削除されるラベル（連結時に有効）
サンプル :
// 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);

deleteLabel()

  • ラベルを削除する

    参考；getName

サンプル :
var label = GmailApp.getUserLabelByName("MyLabel");
label.deleteLabel();

getName()

戻り値 :
Type説明
String ラベル名
サンプル :
var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getName()); //logs MyLabel

getThreads()

  • このラベルでマークされたスレッドを取得する

    この呼び出しはシステムが制御するには大きすぎるスレッドサイズの場合はエラーとなる。 スレッドサイズが未知、または前以て非常に大きいと思われる場合は”paged”を呼び出して、呼び出しのなかで回収されるスレッド範囲を特定す

    参考；getUnreadCount

戻り値 :
Type説明
GmailThread[ ] このラベル名でマークされた複数スレッドの配列
サンプル :
// Log the subject lines of the threads labelled with MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = label.getThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

getThreads(start, max)

  • このラベルでマークされたスレッドの範囲を取得する

    参考；getUnreadCount

Arguments :
nameType説明
startint 最初のスレッドのインデックス
maxint 返すべきスレッド数の最大値
戻り値 :
Type説明
GmailThread[ ] このラベル名でマークされた複数スレッドの配列
サンプル :
// 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());
}

getUnreadCount()

  • このラベルでマークされた未読スレッドを取得する

    参考；getThreads

戻り値 :
Type説明
int このラベル名でマークされた未読スレッドの数
サンプル :
// log the number of unread messages labelled with MyLabel
var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getUnreadCount());