Ein vom Nutzer erstelltes Label im Gmail-Konto des Nutzers.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
add | Gmail | Fügt dem angegebenen Thread dieses Label hinzu und erzwingt eine Aktualisierung des Threads (Gmail ). |
add | Gmail | Fügt den angegebenen Threads dieses Label hinzu und erzwingt eine Aktualisierung der Threads. |
delete | void | Damit wird dieses Label gelöscht. |
get | String | Ruft die ID dieses Labels ab. |
get | String | Ruft den Namen dieses Labels ab. |
get | Gmail | Ruft die Threads ab, die mit diesem Label gekennzeichnet sind. |
get | Gmail | Ruft einen Bereich von Threads ab, die mit diesem Label gekennzeichnet sind. |
get | Integer | Gibt die Anzahl der ungelesenen Threads zurück, die mit diesem Label getaggt sind. |
remove | Gmail | Entfernt dieses Label aus der angegebenen Konversation und erzwingt eine Aktualisierung der Konversation. |
remove | Gmail | Entfernt dieses Label aus den angegebenen Konversationen und erzwingt eine Aktualisierung der Konversationen. |
Detaillierte Dokumentation
add To Thread(thread)
Fügt dem angegebenen Thread dieses Label hinzu und erzwingt eine Aktualisierung des Threads (Gmail
).
// 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
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | Der zu kennzeichnende Thread. |
Rückflug
Gmail
: Dieses Label zur Verkettung.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
add To Threads(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 const label = GmailApp.getUserLabelByName('MyLabel'); const threads = GmailApp.getInboxThreads(0, 3); label.addToThreads(threads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | Gmail | Ein Array von Threads, die gekennzeichnet werden sollen. |
Rückflug
Gmail
: Dieses Label zur Verkettung.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
delete Label()
Damit wird dieses Label gelöscht.
const label = GmailApp.getUserLabelByName('MyLabel'); label.deleteLabel();
Löst
Error
: Das Label kann nicht gelöscht werden.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
get Id()
Ruft die ID dieses Labels ab.
const label = GmailApp.getUserLabelByName('MyLabel'); console.log(label.getId());
Rückflug
String
: Die ID des Labels.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
get Name()
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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
get Threads()
Ruft die Threads ab, die mit diesem Label gekennzeichnet sind.
Diese Aufrufe schlagen fehl, wenn die Größe aller Threads zu groß für das System ist. Wenn die Threadgröße unbekannt und möglicherweise sehr groß ist, verwenden Sie get
und geben Sie in jedem Aufruf Bereiche der abzurufenden Threads an.
// 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
Gmail
: Ein Array von Threads, die mit diesem Label gekennzeichnet sind.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
get Threads(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 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
Name | Typ | Beschreibung |
---|---|---|
start | Integer | Der Index des Startthreads. |
max | Integer | Die maximale Anzahl der zurückzugebenden Threads. |
Rückflug
Gmail
: Ein Array von Threads, die mit diesem Label gekennzeichnet sind.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
get Unread Count()
Gibt die Anzahl der ungelesenen Threads zurück, 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
remove From Thread(thread)
Entfernt dieses Label aus der angegebenen Konversation und erzwingt eine Aktualisierung der Konversation.
// 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
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | Der Thread wird nicht mehr gekennzeichnet. |
Rückflug
Gmail
: Dieses Label zur Verkettung.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
remove From Threads(threads)
Entfernt dieses Label aus den angegebenen Konversationen und erzwingt eine Aktualisierung der Konversationen. Sie können Labels für bis zu 100 Unterhaltungen pro Batch 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
Name | Typ | Beschreibung |
---|---|---|
threads | Gmail | Ein Array von Threads, die nicht mehr gelabelt werden sollen. |
Rückflug
Gmail
: Dieses Label zur Verkettung.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:
-
https://mail.google.com/