Class GmailLabel

Fügen Sie dem angegebenen Thread dieses Label hinzu und erzwingen Sie eine Aktualisierung des Threads (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);

Parameter

Rückflug

GmailLabel – Dieses Label für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Weitere Informationen

• removeFromThread(thread)

Fügt den angegebenen Threads dieses Label hinzu und erzwingt die Aktualisierung der Threads. Sie können Labels für bis zu 100 Threads pro Batch hinzufügen.

// 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);

Parameter

Rückflug

GmailLabel – Dieses Label für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Weitere Informationen

• removeFromThreads(threads)

Damit wird dieses Label gelöscht.

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

Löst aus

Error – wenn das Label nicht gelöscht werden kann

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Weitere Informationen

• getName()

Ruft den Namen dieses Labels ab.

const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getName());  // logs MyLabel

Rückflug

String: Der Name des Labels.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Ruft die Threads ab, die mit diesem Label gekennzeichnet sind.

Diese Aufrufe schlagen fehl, wenn die Größe aller Threads für das System zu groß ist. Wenn die Threadgröße unbekannt und potenziell sehr groß ist, verwenden Sie getThreads(start, max) und geben Sie bei jedem Aufruf Bereiche der Threads an, die abgerufen werden sollen.

// 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());
}

Rückflug

GmailThread[]: Ein Array von Threads, die mit diesem Label gekennzeichnet sind.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Hiermit werden mehrere Threads abgerufen, die mit diesem Label gekennzeichnet sind.

// 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());
}

Parameter

Rückflug

GmailThread[]: Ein Array von Threads, die mit diesem Label gekennzeichnet sind.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Die Anzahl der ungelesenen Threads, die mit diesem Label getaggt sind.

// log the number of unread threads labeled with MyLabel
const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getUnreadCount());

Rückflug

Integer – Die Anzahl der ungelesenen Threads mit Label.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Entfernt dieses Label aus der angegebenen Unterhaltung und erzwingt eine Aktualisierung der Unterhaltung.

// 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);

Parameter

Rückflug

GmailLabel – Dieses Label für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Weitere Informationen

• addToThread(thread)

Entfernt dieses Label aus den angegebenen Threads und erzwingt ein Aktualisieren der Threads. Sie können Labels für bis zu 100 Unterhaltungen gleichzeitig entfernen.

// 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);

Parameter

Rückflug

GmailLabel – Dieses Label für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

• https://mail.google.com/

Weitere Informationen

• addToThreads(threads)