Class GmailLabel

Gmailラベル

ユーザーの 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
const label = GmailApp.getUserLabelByName('MyLabel');
const 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.addToThreads(threads);

パラメータ

名前型説明
threadsGmailThread[]ラベルを付けるスレッドの配列。

戻る

GmailLabel - チェーン用のラベル。

承認

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

  • https://mail.google.com/

関連情報

deleteLabel()

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

const label = GmailApp.getUserLabelByName('MyLabel');
label.deleteLabel();

例外

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

承認

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

  • https://mail.google.com/

関連情報

getName()

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

const 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads();
for (let 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads(0, 30);
for (let 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
const 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
const label = GmailApp.getUserLabelByName('MyLabel');
const 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.removeFromThreads(threads);

パラメータ

名前型説明
threadsGmailThread[]ラベルを付けないスレッドの配列。

戻る

GmailLabel - チェーン用のラベル。

承認

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

  • https://mail.google.com/

関連情報