Class GmailLabel

GmailLabel

Ein vom Nutzer erstelltes Label im Gmail-Konto eines Nutzers.

Methoden

MethodeRückgabetypKurzbeschreibung
addToThread(thread)GmailLabelFügt dieses Label dem angegebenen Thread hinzu und erzwingt eine Aktualisierung des Threads (GmailThread.refresh()).
addToThreads(threads)GmailLabelFügt den angegebenen Threads dieses Label hinzu und erzwingt eine Aktualisierung der Threads.
deleteLabel()voidLöscht dieses Label.
getName()StringLiefert den Namen dieses Labels.
getThreads()GmailThread[]Ruft die Threads ab, die mit diesem Label gekennzeichnet sind.
getThreads(start, max)GmailThread[]Ruft einen Bereich von Threads ab, die mit diesem Label gekennzeichnet sind.
getUnreadCount()IntegerRuft die Anzahl der ungelesenen Threads ab, die mit diesem Label getaggt sind.
removeFromThread(thread)GmailLabelEntfernt dieses Label aus dem angegebenen Thread und erzwingt eine Aktualisierung des Threads.
removeFromThreads(threads)GmailLabelEntfernt dieses Label aus den angegebenen Threads und erzwingt eine Aktualisierung der Threads.

Detaillierte Dokumentation

addToThread(thread)

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

Parameter

NameTypBeschreibung
threadGmailThreadDer Thread, dem ein Label hinzugefügt werden soll.

Return

GmailLabel: Dieses Label für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


addToThreads(threads)

Fügt den angegebenen Threads dieses Label hinzu und erzwingt eine 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
var label = GmailApp.getUserLabelByName("MyLabel");
var threads = GmailApp.getInboxThreads(0,3);
label.addToThreads(threads);

Parameter

NameTypBeschreibung
threadsGmailThread[]Ein Array von Threads, die mit einem Label versehen werden sollen.

Return

GmailLabel: Dieses Label für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


deleteLabel()

Löscht dieses Label.

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

Löst aus

Error: Wenn das Label nicht gelöscht werden kann

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getName()

Liefert den Namen dieses Labels.

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

Return

String: Der Name des Labels.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getThreads()

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

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

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

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getThreads(start, max)

Ruft einen Bereich von Threads ab, die mit diesem Label gekennzeichnet sind.

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

Parameter

NameTypBeschreibung
startIntegerDer Index des Startthreads.
maxIntegerDie maximale Anzahl der zurückzugebenden Threads.

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getUnreadCount()

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

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

Return

Integer: Die Anzahl der ungelesenen Threads mit Labels.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

removeFromThread(thread)

Entfernt dieses Label aus dem angegebenen Thread und erzwingt eine Aktualisierung des Threads.

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

Parameter

NameTypBeschreibung
threadGmailThreadDer Thread hat kein Label.

Return

GmailLabel: Dieses Label für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


removeFromThreads(threads)

Entfernt dieses Label aus den angegebenen Threads und erzwingt eine Aktualisierung der Threads. Sie können Labels für bis zu 100 Threads pro Batch entfernen.

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

Parameter

NameTypBeschreibung
threadsGmailThread[]Ein Array von Threads, denen kein Label zugewiesen werden soll.

Return

GmailLabel: Dieses Label für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen