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/

関連ドキュメント