Class GmailLabel

GmailLabel

ユーザーの Gmail アカウントでユーザーが作成したラベル。

Methods

メソッド戻り値の型概要
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 - このラベル。チェーンに使用します。

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する 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 - このラベル。チェーンに使用します。

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する REST API による適切なスコープによる承認が必要です。

  • https://mail.google.com/

関連ドキュメント


deleteLabel()

このラベルを削除します。

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

スロー値

Error - ラベルを削除できない場合

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する REST API による適切なスコープによる承認が必要です。

  • https://mail.google.com/

関連ドキュメント


getName()

このラベルの名前を取得します。

var label = GmailApp.getUserLabelByName("MyLabel");
Logger.log(label.getName()); //logs MyLabel

戻る

String - ラベルの名前。

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する 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[] - このラベルでマークされたスレッドの配列。

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する 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[] - このラベルでマークされたスレッドの配列。

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する 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 - ラベルなしのスレッドの数。

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する 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 - このラベル。チェーンに使用します。

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する 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 - このラベル。チェーンに使用します。

承認

このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する REST API による適切なスコープによる承認が必要です。

  • https://mail.google.com/

関連ドキュメント