Ein vom Nutzer erstelltes Label im Gmail-Konto eines Nutzers.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addToThread(thread) | GmailLabel | Fügt dieses Label dem angegebenen Thread hinzu und erzwingt eine Aktualisierung des Threads (GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | Fügt den angegebenen Threads dieses Label hinzu und erzwingt eine Aktualisierung der Threads. |
deleteLabel() | void | Löscht dieses Label. |
getName() | String | Liefert 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() | Integer | Ruft die Anzahl der ungelesenen Threads ab, die mit diesem Label getaggt sind. |
removeFromThread(thread) | GmailLabel | Entfernt dieses Label aus dem angegebenen Thread und erzwingt eine Aktualisierung des Threads. |
removeFromThreads(threads) | GmailLabel | Entfernt 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
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | Der 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
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | 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
Name | Typ | Beschreibung |
---|---|---|
start | Integer | Der Index des Startthreads. |
max | Integer | Die 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
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | Der 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
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | 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/