Ein vom Nutzer im Gmail-Konto eines Nutzers erstelltes Label.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addToThread(thread) | GmailLabel | Fügt dem angegebenen Thread dieses Label 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 | Ruft den Namen dieses Labels ab. |
getThreads() | GmailThread[] | Ruft die Threads ab, die mit diesem Label markiert sind. |
getThreads(start, max) | GmailThread[] | Ruft einen Bereich von Threads ab, die mit diesem Label markiert sind. |
getUnreadCount() | Integer | Ruft die Anzahl der ungelesenen Threads ab, die mit diesem Label gekennzeichnet 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 dem angegebenen Thread dieses Label 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. |
Rückflug
GmailLabel
: Dieses Label zur Verkettung.
Autorisierung
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
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 hinzufügen für bis zu 100 Threads pro Batch.
// 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. |
Rückflug
GmailLabel
: Dieses Label zur Verkettung.
Autorisierung
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
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
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
https://mail.google.com/
Weitere Informationen
getName()
Ruft den Namen dieses Labels ab.
var label = GmailApp.getUserLabelByName("MyLabel"); Logger.log(label.getName()); //logs MyLabel
Rückflug
String
: Der Name des Labels.
Autorisierung
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
https://mail.google.com/
getThreads()
Ruft die Threads ab, die mit diesem Label markiert sind.
Diese Aufrufe schlagen fehl, wenn alle Threads zu groß sind, um vom System verarbeitet zu werden. Wo?
Die Thread-Größe ist unbekannt und möglicherweise sehr groß. Verwenden Sie getThreads(start, max)
und geben Sie Bereiche der Threads an, die in 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()); }
Rückflug
GmailThread[]
: Ein Array von Threads, die mit diesem Label gekennzeichnet sind.
Autorisierung
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
https://mail.google.com/
getThreads(start, max)
Ruft einen Bereich von Threads ab, die mit diesem Label markiert 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. |
Rückflug
GmailThread[]
: Ein Array von Threads, die mit diesem Label gekennzeichnet sind.
Autorisierung
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
https://mail.google.com/
getUnreadCount()
Ruft die Anzahl der ungelesenen Threads ab, die mit diesem Label gekennzeichnet sind.
// log the number of unread threads labeled with MyLabel var label = GmailApp.getUserLabelByName("MyLabel"); Logger.log(label.getUnreadCount());
Rückflug
Integer
: Die Anzahl der ungelesenen mit Labels versehenen Threads.
Autorisierung
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
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 | Das Label des Threads hat kein Label. |
Rückflug
GmailLabel
: Dieses Label zur Verkettung.
Autorisierung
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
https://mail.google.com/
Weitere Informationen
removeFromThreads(threads)
Entfernt dieses Label aus den angegebenen Threads und erzwingt eine Aktualisierung der Threads. Sie können Folgendes entfernen: Labels für bis zu 100 Threads pro Batch.
// 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. |
Rückflug
GmailLabel
: Dieses Label zur Verkettung.
Autorisierung
Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:
-
https://mail.google.com/