Class GmailLabel

GmailLabel

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

Methoden

MethodeRückgabetypKurzbeschreibung
addToThread(thread)GmailLabelFügen Sie dem angegebenen Thread dieses Label hinzu und erzwingen Sie eine Aktualisierung des Threads (GmailThread.refresh()).
addToThreads(threads)GmailLabelFügt den angegebenen Threads dieses Label hinzu und erzwingt die Aktualisierung der Threads.
deleteLabel()voidDamit wird dieses Label gelöscht.
getId()StringRuft die ID dieses Labels ab.
getName()StringRuft den Namen dieses Labels ab.
getThreads()GmailThread[]Ruft die Threads ab, die mit diesem Label gekennzeichnet sind.
getThreads(start, max)GmailThread[]Hiermit werden mehrere Threads abgerufen, die mit diesem Label gekennzeichnet sind.
getUnreadCount()IntegerDie Anzahl der ungelesenen Threads, die mit diesem Label getaggt sind.
removeFromThread(thread)GmailLabelEntfernt dieses Label aus der angegebenen Unterhaltung und erzwingt eine Aktualisierung der Unterhaltung.
removeFromThreads(threads)GmailLabelEntfernt dieses Label aus den angegebenen Threads und erzwingt ein Aktualisieren der Threads.

Detaillierte Dokumentation

addToThread(thread)

Fügen Sie dem angegebenen Thread dieses Label hinzu und erzwingen Sie 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

NameTypBeschreibung
threadGmailThreadDer Thread, der getaggt werden soll.

Rückflug

GmailLabel – Dieses Label für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen

addToThreads(threads)

Fügt den angegebenen Threads dieses Label hinzu und erzwingt die 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

NameTypBeschreibung
threadsGmailThread[]Ein Array von Threads, die getaggt werden sollen.

Rückflug

GmailLabel – Dieses Label für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen

deleteLabel()

Damit wird dieses Label gelöscht. 

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

Löst

Error – wenn das Label nicht gelöscht werden kann

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen

getId()

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 geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getName()

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 geeigneten Zugriffsbereiche 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 die Größe aller Threads für das System zu groß ist. Wenn die Threadgröße unbekannt und potenziell sehr groß ist, verwenden Sie getThreads(start, max) und geben Sie bei jedem Aufruf Bereiche der Threads an, die 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ückflug

GmailThread[]: 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 geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getThreads(start, max)

Hiermit werden mehrere Threads abgerufen, 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

NameTypBeschreibung
startIntegerDer Index des Startthreads.
maxIntegerDie maximale Anzahl der Threads, die zurückgegeben werden sollen.

Rückflug

GmailThread[]: 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 geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getUnreadCount()

Die Anzahl der ungelesenen Threads, 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 getaggten Threads.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

removeFromThread(thread)

Entfernt dieses Label aus der angegebenen Unterhaltung und erzwingt eine Aktualisierung der Unterhaltung. 

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

NameTypBeschreibung
threadGmailThreadDer Thread ist nicht gekennzeichnet.

Rückflug

GmailLabel – Dieses Label für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen

removeFromThreads(threads)

Entfernt dieses Label aus den angegebenen Threads und erzwingt ein Aktualisieren der Threads. Sie können Labels für bis zu 100 Unterhaltungen gleichzeitig 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

NameTypBeschreibung
threadsGmailThread[]Ein Array von Threads, die keine Labels haben sollen.

Rückflug

GmailLabel – Dieses Label für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder geeigneten Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen