Class GmailLabel

GmailLabel

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 dieses Label den angegebenen Threads hinzu und erzwingt eine Aktualisierung der Threads.
deleteLabel()	void	Löscht dieses Label.
getId()	String	Ruft die ID dieses Labels ab.
getName()	String	Ruft den Namen dieses Labels ab.
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 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 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
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.addToThread(firstThread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	Der Thread, der mit einem Label versehen werden soll.

Rückgabe

GmailLabel : Dieses Label für die Verkettung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen aus der zugehörigen REST API erforderlich:

• https://mail.google.com/

Weitere Informationen

• removeFromThread(thread)

---

addToThreads(threads)

Fügt dieses Label den angegebenen Threads 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	GmailThread[]	Ein Array von Threads, die mit einem Label versehen werden sollen.

Rückgabe

GmailLabel : Dieses Label für die Verkettung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen aus der zugehörigen REST API erforderlich:

• https://mail.google.com/

Weitere Informationen

• removeFromThreads(threads)

---

deleteLabel()

Löscht dieses Label.

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

Löst

Error : wenn das Label nicht gelöscht werden kann

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen aus der zugehörigen REST API erforderlich:

• https://mail.google.com/

Weitere Informationen

• getName()

---

getId()

Ruft die ID dieses Labels ab.

const label = GmailApp.getUserLabelByName('MyLabel');
console.log(label.getId());

Rückgabe

String : Die ID des Labels.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen aus der zugehörigen REST API erforderlich:

• https://mail.google.com/

---

getName()

Ruft den Namen dieses Labels ab.

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

Rückgabe

String : Der Name des Labels.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen aus der zugehörigen REST API erforderlich:

• https://mail.google.com/

---

getThreads()

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 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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = label.getThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Rückgabe

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen aus der zugehörigen REST API erforderlich:

• 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
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ückgabe

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen 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
const label = GmailApp.getUserLabelByName('MyLabel');
Logger.log(label.getUnreadCount());

Rückgabe

Integer : Die Anzahl der ungelesenen Threads mit Label.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen 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
const label = GmailApp.getUserLabelByName('MyLabel');
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
label.removeFromThread(firstThread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	Der Thread, dessen Label entfernt werden soll.

Rückgabe

GmailLabel : Dieses Label für die Verkettung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen aus der zugehörigen REST API erforderlich:

• https://mail.google.com/

Weitere Informationen

• addToThread(thread)

---

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
const label = GmailApp.getUserLabelByName('MyLabel');
const threads = GmailApp.getInboxThreads(0, 3);
label.removeFromThreads(threads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array von Threads, deren Label entfernt werden soll.

Rückgabe

GmailLabel : Dieses Label für die Verkettung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Zugriffsbereiche oder entsprechenden Zugriffsbereichen aus der zugehörigen REST API erforderlich:

• https://mail.google.com/

Weitere Informationen

• addToThreads(threads)