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 - チェーン用のラベル。

承認

このメソッドを使用するスクリプトでは、次のスコープの 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/

関連情報