Class GmailApp

GmailApp

Bietet Zugriff auf Gmail-Konversationen, ‑Nachrichten und ‑Labels.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
createDraft(recipient, subject, body)	GmailDraft	Erstellt einen E‑Mail-Entwurf.
createDraft(recipient, subject, body, options)	GmailDraft	Erstellt eine E‑Mail-Nachricht als Entwurf mit optionalen Argumenten.
createLabel(name)	GmailLabel	Erstellt ein neues Nutzerlabel mit dem angegebenen Namen.
deleteLabel(label)	GmailApp	Löscht das angegebene Label.
getAliases()	String[]	Ruft eine Liste der E‑Mail-Adressen ab, die in Gmail als Aliase für dieses Konto eingerichtet sind.
getDraft(draftId)	GmailDraft	E‑Mail-Entwurf anhand der ID abrufen
getDraftMessages()	GmailMessage[]	Ruft alle E‑Mail-Entwürfe ab.
getDrafts()	GmailDraft[]	Ruft alle Gmail-Nachrichtenentwürfe ab.
getInboxThreads()	GmailThread[]	Ruft alle Inbox-Konversationen unabhängig von Labels ab.
getInboxThreads(start, max)	GmailThread[]	Ruft einen Bereich von Posteingangsthreads unabhängig von Labels ab.
getInboxUnreadCount()	Integer	Ruft die Anzahl der ungelesenen Threads im Posteingang ab.
getMessageById(id)	GmailMessage	Ruft eine Nachricht anhand der ID ab.
getMessagesForThread(thread)	GmailMessage[]	Alle Nachrichten im angegebenen Thread abrufen.
getMessagesForThreads(threads)	GmailMessage[][]	Alle Nachrichten in den angegebenen Threads abrufen.
getPriorityInboxThreads()	GmailThread[]	Ruft alle Threads im sortierten Eingang ab, unabhängig von Labels.
getPriorityInboxThreads(start, max)	GmailThread[]	Ruft eine Reihe von Konversationen im sortierten Eingang unabhängig von Labels ab.
getPriorityInboxUnreadCount()	Integer	Ruft die Anzahl der ungelesenen Unterhaltungen im sortierten Eingang ab.
getSpamThreads()	GmailThread[]	Ruft alle Spam-Konversationen unabhängig von Labels ab.
getSpamThreads(start, max)	GmailThread[]	Ruft einen Bereich von Spam-Threads unabhängig von Labels ab.
getSpamUnreadCount()	Integer	Ruft die Anzahl der ungelesenen Threads ab, die Spam sind.
getStarredThreads()	GmailThread[]	Ruft alle mit Sternchen markierten Threads unabhängig von Labels ab.
getStarredThreads(start, max)	GmailThread[]	Ruft einen Bereich mit markierten Threads unabhängig von Labels ab.
getStarredUnreadCount()	Integer	Ruft die Anzahl der ungelesenen Threads ab, die mit einem Sternchen markiert sind.
getThreadById(id)	GmailThread|null	Ruft einen Thread nach ID ab.
getTrashThreads()	GmailThread[]	Ruft alle Threads im Papierkorb unabhängig von Labels ab.
getTrashThreads(start, max)	GmailThread[]	Ruft einen Bereich von gelöschten Threads unabhängig von Labels ab.
getUserLabelByName(name)	GmailLabel	Ruft ein Label anhand des Labelnamens ab.
getUserLabels()	GmailLabel[]	Ruft eine Liste der vom Nutzer erstellten Labels ab.
markMessageRead(message)	GmailApp	Diese Nachricht wird als gelesen markiert und die Nachricht wird aktualisiert.
markMessageUnread(message)	GmailApp	Diese Nachricht wird als ungelesen markiert und die Nachricht wird aktualisiert.
markMessagesRead(messages)	GmailApp	Markiert diese Nachrichten als gelesen und erzwingt eine Aktualisierung der Nachrichten.
markMessagesUnread(messages)	GmailApp	Markiert diese Nachrichten als ungelesen und erzwingt eine Aktualisierung der Nachrichten.
markThreadImportant(thread)	GmailApp	Markiert diesen Thread als wichtig und erzwingt eine Aktualisierung des Threads.
markThreadRead(thread)	GmailApp	Markiert diesen Thread als gelesen und erzwingt eine Aktualisierung des Threads.
markThreadUnimportant(thread)	GmailApp	Markiert diesen Thread als unwichtig und erzwingt eine Aktualisierung des Threads.
markThreadUnread(thread)	GmailApp	Markiert diesen Thread als ungelesen und erzwingt eine Aktualisierung des Threads.
markThreadsImportant(threads)	GmailApp	Markiert diese Threads als wichtig und erzwingt, dass sie aktualisiert werden.
markThreadsRead(threads)	GmailApp	Diese Threads werden als gelesen markiert und aktualisiert.
markThreadsUnimportant(threads)	GmailApp	Markiert diese Threads als unwichtig und erzwingt, dass sie aktualisiert werden.
markThreadsUnread(threads)	GmailApp	Diese Threads werden als ungelesen markiert und aktualisiert.
moveMessageToTrash(message)	GmailApp	Verschiebt die Nachricht in den Papierkorb und erzwingt eine Aktualisierung der Nachricht.
moveMessagesToTrash(messages)	GmailApp	Verschiebt die angegebenen Nachrichten in den Papierkorb und erzwingt eine Aktualisierung der Nachrichten.
moveThreadToArchive(thread)	GmailApp	Verschiebt diesen Thread ins Archiv und erzwingt eine Aktualisierung des Threads.
moveThreadToInbox(thread)	GmailApp	Verschiebt diesen Thread in den Posteingang und erzwingt eine Aktualisierung des Threads.
moveThreadToSpam(thread)	GmailApp	Verschiebt diesen Thread in den Spamordner und erzwingt eine Aktualisierung des Threads.
moveThreadToTrash(thread)	GmailApp	Verschiebt diesen Thread in den Papierkorb und erzwingt eine Aktualisierung des Threads.
moveThreadsToArchive(threads)	GmailApp	Verschiebt diese Threads ins Archiv und erzwingt, dass die Threads aktualisiert werden.
moveThreadsToInbox(threads)	GmailApp	Verschiebt diese Threads in den Posteingang und erzwingt eine Aktualisierung der Threads.
moveThreadsToSpam(threads)	GmailApp	Verschiebt diese Threads in den Spamordner und erzwingt eine Aktualisierung der Threads.
moveThreadsToTrash(threads)	GmailApp	Verschiebt diese Threads in den Papierkorb und erzwingt eine Aktualisierung der Threads.
refreshMessage(message)	GmailApp	Lädt die Nachricht und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).
refreshMessages(messages)	GmailApp	Lädt die Nachrichten und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).
refreshThread(thread)	GmailApp	Lädt den Thread und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).
refreshThreads(threads)	GmailApp	Lädt die Threads und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).
search(query)	GmailThread[]	Suchen Sie in Gmail mit der angegebenen Anfrage.
search(query, start, max)	GmailThread[]	Suchen Sie in Gmail mit der angegebenen Anfrage.
sendEmail(recipient, subject, body)	GmailApp	Sendet eine E‑Mail-Nachricht.
sendEmail(recipient, subject, body, options)	GmailApp	Sendet eine E‑Mail-Nachricht mit optionalen Argumenten.
setCurrentMessageAccessToken(accessToken)	void	Legt das Zugriffstoken für die aktuelle Nachricht fest, mit dem das Skript auf die aktuellen GmailMessage-Eigenschaften zugreifen kann.
starMessage(message)	GmailApp	Fügt dieser Nachricht einen Stern hinzu und erzwingt eine Aktualisierung der Nachricht.
starMessages(messages)	GmailApp	Diesen Nachrichten werden Sterne hinzugefügt und sie werden aktualisiert.
unstarMessage(message)	GmailApp	Entfernt die Sternmarkierung aus dieser Nachricht und erzwingt eine Aktualisierung der Nachricht.
unstarMessages(messages)	GmailApp	Entfernt die Sternmarkierungen aus diesen Nachrichten und erzwingt eine Aktualisierung der Nachrichten.

Eingestellte Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getChatThreads()	GmailThread[]	Ruft alle Unterhaltungen aus dem klassischen Google Hangouts und Google Chat ab, bis Google alle Nutzer des klassischen Hangouts im Laufe des Jahres zu Chat migriert.
getChatThreads(start, max)	GmailThread[]	Ruft eine Reihe von Threads aus dem klassischen Google Hangouts und Google Chat ab, bis Google alle Nutzer des klassischen Hangouts im Laufe des Jahres zu Chat migriert.

Detaillierte Dokumentation

createDraft(recipient, subject, body)

Erstellt einen E‑Mail-Entwurf. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parameter

Name	Typ	Beschreibung
recipient	String	Durch Kommas getrennte Liste der E‑Mail-Adressen
subject	String	Betreff der E‑Mail
body	String	E‑Mail-Text

Rückflug

GmailDraft – der neu erstellte Gmail-Entwurf

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

• createDraft(recipient, subject, body, options)

---

createDraft(recipient, subject, body, options)

Erstellt eine E‑Mail-Nachricht als Entwurf mit optionalen Argumenten. Die E‑Mail kann Nur-Text oder einen HTML-Text enthalten. Die Größe der E‑Mail (einschließlich Kopfzeilen, aber ohne Anhänge) ist kontingentbeschränkt.

// Create a draft email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft(
    '[e-mail]',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

Parameter

Name	Typ	Beschreibung
recipient	String	die Adressen des Empfängers
subject	String	die Betreffzeile
body	String	den Text der E‑Mail
options	Object	Ein JavaScript-Objekt, das erweiterte Parameter angibt (siehe unten)

Erweiterte Parameter

Name	Typ	Beschreibung
attachments	BlobSource[]	ein Array von Dateien, die mit der E‑Mail gesendet werden sollen
bcc	String	Eine durch Kommas getrennte Liste der E‑Mail-Adressen, die in die BCC-Zeile eingefügt werden sollen
cc	String	Eine durch Kommas getrennte Liste der E‑Mail-Adressen, die in Cc gesetzt werden sollen
from	String	Die Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von getAliases() zurückgegebenen Werte sein.
htmlBody	String	Wenn dieser Parameter festgelegt ist, verwenden Geräte, die HTML rendern können, ihn anstelle des erforderlichen „body“-Arguments. Sie können dem HTML-Textkörper ein optionales inlineImages-Feld hinzufügen, wenn Sie Inline-Bilder für Ihre E-Mail haben.
inlineImages	Object	Ein JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (BlobSource) enthält. Dabei wird davon ausgegangen, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält.
name	String	Der Name des Absenders der E‑Mail (Standard: der Name des Nutzers)
replyTo	String	Eine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers)

Rückflug

GmailDraft – der neu erstellte Gmail-Entwurf

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

• createDraft(recipient, subject, body)

---

createLabel(name)

Erstellt ein neues Nutzerlabel mit dem angegebenen Namen.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Parameter

Name	Typ	Beschreibung
name	String	Der Name des neuen Labels

Rückflug

GmailLabel: Das neu erstellte 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/

Weitere Informationen

• deleteLabel(label)

---

deleteLabel(label)

Löscht das angegebene Label.

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

Parameter

Name	Typ	Beschreibung
label	GmailLabel	Das zu löschende Label

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• createLabel(name)

---

getAliases()

Ruft eine Liste der E‑Mail-Adressen ab, die in Gmail als Aliase für dieses Konto eingerichtet sind.

Sie können eine Nachricht von einem dieser Aliase aus senden, indem Sie das optionale Argument „from“ verwenden.

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {
    from: aliases[0],
  });
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Rückflug

String[]: Ein Array von Aliasen für dieses Konto

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

• sendEmail(recipient, subject, body, options)

---

getDraft(draftId)

E‑Mail-Entwurf anhand der ID abrufen

Verwenden Sie diese Methode in Verbindung mit getId() für Gmail-Entwürfe.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

Parameter

Name	Typ	Beschreibung
draftId	String	die ID des abzurufenden Entwurfs

Rückflug

GmailDraft: der Entwurf mit der angegebenen ID

Löst

Error – wenn kein Entwurf mit der angegebenen ID gefunden werden kann

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/

---

getDraftMessages()

Ruft alle E‑Mail-Entwürfe ab.

// Logs the number of draft messages
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Rückflug

GmailMessage[] – ein Array mit Gmail-Nachrichtentwürfen

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/

---

getDrafts()

Ruft alle Gmail-Nachrichtenentwürfe ab.

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Rückflug

GmailDraft[] – ein Array von Gmail-Nachrichtenentwürfen

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/

---

getInboxThreads()

Ruft alle Inbox-Konversationen unabhängig von Labels ab.

Dieser Aufruf schlägt 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 den Aufruf „paged“ und geben Sie in jedem Aufruf Bereiche der abzurufenden Threads an.

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Rückflug

GmailThread[] – ein Array von Gmail-Konversationen im Posteingang

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/

---

getInboxThreads(start, max)

Ruft einen Bereich von Posteingangsthreads unabhängig von Labels ab.

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parameter

Name	Typ	Beschreibung
start	Integer	Der Index des ersten abzurufenden Threads.
max	Integer	Die maximale Anzahl der abzurufenden Threads

Rückflug

GmailThread[] – ein Array von Gmail-Konversationen im Posteingang

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/

---

getInboxUnreadCount()

Ruft die Anzahl der ungelesenen Threads im Posteingang ab.

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

Rückflug

Integer – die Anzahl der Unterhaltungen im Posteingang, die ungelesene Nachrichten enthalten

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/

---

getMessageById(id)

Ruft eine Nachricht anhand der ID ab.

Verwenden Sie diese Methode in Verbindung mit getId() für Gmail-Nachrichten.

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

Parameter

Name	Typ	Beschreibung
id	String	die ID der Nachricht, die abgerufen werden soll

Rückflug

GmailMessage: die Nachricht mit der angegebenen ID

Löst

Error – wenn keine Nachricht mit der angegebenen ID gefunden werden kann

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

• getThreadById(id)

---

getMessagesForThread(thread)

Alle Nachrichten im angegebenen Thread abrufen.

// Log all the subject lines in the first thread of your inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let i = 0; i < messages.length; i++) {
  Logger.log(`subject: ${messages[i].getSubject()}`);
}

Parameter

Name	Typ	Beschreibung
thread	GmailThread	der abzurufende Nachrichtenverlauf

Rückflug

GmailMessage[] – Array von Nachrichten, die dieser Unterhaltung entsprechen

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

• getMessagesForThreads(threads)

---

getMessagesForThreads(threads)

Alle Nachrichten in den angegebenen Threads abrufen.

// Log the subject lines of all messages in the first two threads of your inbox
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	die Threads der abzurufenden Nachrichten

Rückflug

GmailMessage[][]: Ein Array von Arrays von Nachrichten, wobei jedes Element im äußeren Array einem Thread entspricht und das innere Array die Nachrichten in diesem Thread enthält.

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

• getMessagesForThread(thread)

---

getPriorityInboxThreads()

Ruft alle Threads im sortierten Eingang ab, unabhängig von Labels.

Dieser Aufruf schlägt 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 den Aufruf „paged“ und geben Sie in jedem Aufruf Bereiche der abzurufenden Threads an.

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

Rückflug

GmailThread[] – ein Array von Gmail-Konversationen im sortierten Eingang

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/

---

getPriorityInboxThreads(start, max)

Ruft eine Reihe von Konversationen im sortierten Eingang unabhängig von Labels ab.

// Will log some number 2 or less
Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads(0, 2).length}`,
);

Parameter

Name	Typ	Beschreibung
start	Integer	Der Index des ersten abzurufenden Threads.
max	Integer	Die maximale Anzahl der abzurufenden Threads

Rückflug

GmailThread[] – ein Array von Gmail-Konversationen im sortierten Eingang

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/

---

getPriorityInboxUnreadCount()

Ruft die Anzahl der ungelesenen Unterhaltungen im sortierten Eingang ab.

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

Rückflug

Integer: Die Anzahl der Unterhaltungen im Posteingang mit Priorität, die ungelesene Nachrichten enthalten.

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/

---

getSpamThreads()

Ruft alle Spam-Konversationen unabhängig von Labels ab.

Dieser Aufruf schlägt 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 den Aufruf „paged“ und geben Sie in jedem Aufruf Bereiche der abzurufenden Threads an.

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

Rückflug

GmailThread[] – ein Array von Gmail-Konversationen im Spamordner

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/

---

getSpamThreads(start, max)

Ruft einen Bereich von Spam-Threads unabhängig von Labels ab.

// Will log a number at most 5
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`);

Parameter

Name	Typ	Beschreibung
start	Integer	Der Index des ersten abzurufenden Threads.
max	Integer	Die maximale Anzahl der abzurufenden Threads

Rückflug

GmailThread[] – ein Array von Gmail-Konversationen im Spamordner

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/

---

getSpamUnreadCount()

Ruft die Anzahl der ungelesenen Threads ab, die Spam sind.

// Unless you actually read stuff in your spam folder, this should be the same
// as the number of messages in your spam folder.
Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`);

Rückflug

Integer: Anzahl der Spam-Konversationen mit ungelesenen Nachrichten

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/

---

getStarredThreads()

Ruft alle mit Sternchen markierten Threads unabhängig von Labels ab.

Dieser Aufruf schlägt 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 den Aufruf „paged“ und geben Sie in jedem Aufruf Bereiche der abzurufenden Threads an.

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

Rückflug

GmailThread[] – ein Array mit markierten Gmail-Konversationen

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/

---

getStarredThreads(start, max)

Ruft einen Bereich mit markierten Threads unabhängig von Labels ab.

// Logs the number of starred threads to a maximum of 5
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`);

Parameter

Name	Typ	Beschreibung
start	Integer	Der Index des ersten abzurufenden Threads.
max	Integer	Die maximale Anzahl der abzurufenden Threads

Rückflug

GmailThread[] – ein Array mit markierten Gmail-Konversationen

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/

---

getStarredUnreadCount()

Ruft die Anzahl der ungelesenen Threads ab, die mit einem Sternchen markiert sind.

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

Rückflug

Integer: Anzahl der markierten Unterhaltungen mit ungelesenen Nachrichten

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/

---

getThreadById(id)

Ruft einen Thread nach ID ab.

Wird in Verbindung mit getId() für Gmail-Unterhaltungen verwendet.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(
    firstThread.getFirstMessageSubject() ===
        threadById.getFirstMessageSubject(),
);

Parameter

Name	Typ	Beschreibung
id	String	Die ID des abzurufenden Threads.

Rückflug

GmailThread|null – Der Thread mit der angegebenen ID oder null, falls er nicht gefunden wurde.

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

• getMessageById(id)

---

getTrashThreads()

Ruft alle Threads im Papierkorb unabhängig von Labels ab.

Dieser Aufruf schlägt 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 den Aufruf „paged“ und geben Sie in jedem Aufruf Bereiche der abzurufenden Threads an.

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

Rückflug

GmailThread[] – ein Array von Gmail-Threads im Papierkorb

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/

---

getTrashThreads(start, max)

Ruft einen Bereich von gelöschten Threads unabhängig von Labels ab.

// Will log a number at most 5
Logger.log(
    `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`,
);

Parameter

Name	Typ	Beschreibung
start	Integer	Der Index des ersten abzurufenden Threads.
max	Integer	Die maximale Anzahl der abzurufenden Threads

Rückflug

GmailThread[] – ein Array von Gmail-Threads im Papierkorb

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/

---

getUserLabelByName(name)

Ruft ein Label anhand des Labelnamens ab.

const labelObject = GmailApp.getUserLabelByName('myLabel');

Parameter

Name	Typ	Beschreibung
name	String	Der Name des abzurufenden Labels.

Rückflug

GmailLabel: Das Gmail-Label mit dem angegebenen Namen

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/

---

getUserLabels()

Ruft eine Liste der vom Nutzer erstellten Labels ab.

// Logs all of the names of your labels
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

Rückflug

GmailLabel[] – Array mit vom Nutzer erstellten 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/

---

markMessageRead(message)

Diese Nachricht wird als gelesen markiert und die Nachricht wird aktualisiert.

// Mark the first message in the first thread of your inbox as read
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Parameter

Name	Typ	Beschreibung
message	GmailMessage	die Nachricht, die als gelesen markiert werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markMessageUnread(message)

---

markMessageUnread(message)

Diese Nachricht wird als ungelesen markiert und die Nachricht wird aktualisiert.

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parameter

Name	Typ	Beschreibung
message	GmailMessage	die Nachricht, die als ungelesen markiert werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markMessageRead(message)

---

markMessagesRead(messages)

Markiert diese Nachrichten als gelesen und erzwingt eine Aktualisierung der Nachrichten.

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

Parameter

Name	Typ	Beschreibung
messages	GmailMessage[]	Ein Array von Nachrichten, die als gelesen markiert werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markMessagesUnread(messages)

---

markMessagesUnread(messages)

Markiert diese Nachrichten als ungelesen und erzwingt eine Aktualisierung der Nachrichten.

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

Parameter

Name	Typ	Beschreibung
messages	GmailMessage[]	Ein Array von Nachrichten, die als ungelesen markiert werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markMessagesRead(messages)

---

markThreadImportant(thread)

Markiert diesen Thread als wichtig und erzwingt eine Aktualisierung des Threads.

// Marks first inbox thread as important
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	die Unterhaltung, die Sie als wichtig markieren möchten

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markThreadUnimportant(thread)

---

markThreadRead(thread)

Markiert diesen Thread als gelesen und erzwingt eine Aktualisierung des Threads.

// Marks first inbox thread as read
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	Der Thread, der als gelesen markiert werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markThreadUnread(thread)

---

markThreadUnimportant(thread)

Markiert diesen Thread als unwichtig und erzwingt eine Aktualisierung des Threads.

// Marks first inbox thread as unimportant
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	den Thread, der als unwichtig markiert werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markThreadImportant(thread)

---

markThreadUnread(thread)

Markiert diesen Thread als ungelesen und erzwingt eine Aktualisierung des Threads.

// Marks first inbox thread as unread
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	Der Thread, der als ungelesen markiert werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markThreadRead(thread)

---

markThreadsImportant(threads)

Markiert diese Threads als wichtig und erzwingt, dass sie aktualisiert werden.

// Marks first two threads in inbox as important
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array von Threads, die als wichtig markiert werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markThreadsUnimportant(threads)

---

markThreadsRead(threads)

Diese Threads werden als gelesen markiert und aktualisiert.

// Marks first two threads in inbox as read
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array von Threads, die als gelesen markiert werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markThreadsUnread(threads)

---

markThreadsUnimportant(threads)

Markiert diese Threads als unwichtig und erzwingt, dass sie aktualisiert werden.

// Marks first two threads in inbox as unimportant
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array von Threads, die als unwichtig markiert werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markThreadsImportant(threads)

---

markThreadsUnread(threads)

Diese Threads werden als ungelesen markiert und aktualisiert.

// Marks first two threads in inbox as unread
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array von Threads, die als ungelesen markiert werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• markThreadsRead(threads)

---

moveMessageToTrash(message)

Verschiebt die Nachricht in den Papierkorb und erzwingt eine Aktualisierung der Nachricht.

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Parameter

Name	Typ	Beschreibung
message	GmailMessage	Die Nachricht, die in den Papierkorb verschoben werden soll

Rückflug

GmailApp – der Gmail-Dienst (nützlich für die 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

• moveMessagesToTrash(messages)

---

moveMessagesToTrash(messages)

Verschiebt die angegebenen Nachrichten in den Papierkorb und erzwingt eine Aktualisierung der Nachrichten.

// Move first two messages in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parameter

Name	Typ	Beschreibung
messages	GmailMessage[]	die Nachrichten, die in den Papierkorb verschoben werden sollen

Rückflug

GmailApp – der Gmail-Dienst (nützlich für die 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

• moveMessageToTrash(message)

---

moveThreadToArchive(thread)

Verschiebt diesen Thread ins Archiv und erzwingt eine Aktualisierung des Threads.

// Archive the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToArchive(firstThread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	Die zu archivierende Unterhaltung

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

---

moveThreadToInbox(thread)

Verschiebt diesen Thread in den Posteingang und erzwingt eine Aktualisierung des Threads.

// Find a thread not already in your inbox
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	die Konversation, die in den Posteingang verschoben werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadToSpam(thread)

Verschiebt diesen Thread in den Spamordner und erzwingt eine Aktualisierung des Threads.

// Tag first thread in inbox as spam
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToSpam(firstThread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	Die Unterhaltung, die in den Spamordner verschoben werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

---

moveThreadToTrash(thread)

Verschiebt diesen Thread in den Papierkorb und erzwingt eine Aktualisierung des Threads.

// Move first thread in inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToTrash(firstThread);

Parameter

Name	Typ	Beschreibung
thread	GmailThread	der zu löschende Thread

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

---

moveThreadsToArchive(threads)

Verschiebt diese Threads ins Archiv und erzwingt, dass die Threads aktualisiert werden.

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array von zu archivierenden Threads

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

---

moveThreadsToInbox(threads)

Verschiebt diese Threads in den Posteingang und erzwingt eine Aktualisierung der Threads.

// Find two threads not already in your inbox
const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array von Threads, die in den Posteingang verschoben werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToSpam(threads)

Verschiebt diese Threads in den Spamordner und erzwingt eine Aktualisierung der Threads.

// Move first two threads in your inbox to spam
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array mit Threads, die in den Spamordner verschoben werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

---

moveThreadsToTrash(threads)

Verschiebt diese Threads in den Papierkorb und erzwingt eine Aktualisierung der Threads.

// Move first two threads in your inbox to trash
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Ein Array von Threads, die in den Papierkorb verschoben werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

---

refreshMessage(message)

Lädt die Nachricht und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

Parameter

Name	Typ	Beschreibung
message	GmailMessage	Die Nachricht, die aktualisiert werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• refreshMessages(messages)

---

refreshMessages(messages)

Lädt die Nachrichten und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

Parameter

Name	Typ	Beschreibung
messages	GmailMessage[]	die zu aktualisierenden Nachrichten

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• refreshMessage(message)

---

refreshThread(thread)

Lädt den Thread und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Parameter

Name	Typ	Beschreibung
thread	GmailThread	der zu aktualisierende Thread

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• refreshThreads(threads)

---

refreshThreads(threads)

Lädt die Threads und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Parameter

Name	Typ	Beschreibung
threads	GmailThread[]	Die zu aktualisierenden Threads

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• refreshThread(thread)

---

search(query)

Suchen Sie in Gmail mit der angegebenen Anfrage.

Dieser Aufruf schlägt 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 den Aufruf „paged“ und geben Sie in jedem Aufruf Bereiche der abzurufenden Threads an.

// Find starred messages with subject IMPORTANT
const threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Parameter

Name	Typ	Beschreibung
query	String	die Suchanfrage, wie Sie sie in Gmail eingeben würden

Rückflug

GmailThread[] – ein Array von Gmail-Konversationen, die dieser Anfrage entsprechen

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/

---

search(query, start, max)

Suchen Sie in Gmail mit der angegebenen Anfrage.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty
// array.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parameter

Name	Typ	Beschreibung
query	String	die Suchanfrage, wie Sie sie in Gmail eingeben würden
start	Integer	der Index des Startthreads
max	Integer	Die maximale Anzahl der zurückzugebenden Threads

Rückflug

GmailThread[] – ein Array von Gmail-Konversationen, die dieser Anfrage entsprechen

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/

---

sendEmail(recipient, subject, body)

Sendet eine E‑Mail-Nachricht. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parameter

Name	Typ	Beschreibung
recipient	String	Durch Kommas getrennte Liste der E‑Mail-Adressen
subject	String	Betreff der E‑Mail (maximal 250 Zeichen)
body	String	E‑Mail-Text

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• sendEmail(recipient, subject, body, options)

---

sendEmail(recipient, subject, body, options)

Sendet eine E‑Mail-Nachricht mit optionalen Argumenten. Die E‑Mail kann Nur-Text oder einen HTML-Textkörper enthalten. Die Größe der E‑Mail (einschließlich Kopfzeilen, aber ohne Anhänge) ist kontingentbeschränkt.

// Send an email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail(
    '[e-mail]',
    'Attachment example',
    'Please see the attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

Parameter

Name	Typ	Beschreibung
recipient	String	die Adressen des Empfängers
subject	String	die Betreffzeile (maximal 250 Zeichen)
body	String	den Text der E‑Mail
options	Object	Ein JavaScript-Objekt, das erweiterte Parameter angibt (siehe unten)

Erweiterte Parameter

Name	Typ	Beschreibung
attachments	BlobSource[]	ein Array von Dateien, die mit der E‑Mail gesendet werden sollen
bcc	String	Eine durch Kommas getrennte Liste der E‑Mail-Adressen, die in die BCC-Zeile eingefügt werden sollen
cc	String	Eine durch Kommas getrennte Liste der E‑Mail-Adressen, die in Cc gesetzt werden sollen
from	String	Die Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von getAliases() zurückgegebenen Werte sein.
htmlBody	String	Wenn dieser Parameter festgelegt ist, verwenden Geräte, die HTML rendern können, ihn anstelle des erforderlichen „body“-Arguments. Sie können dem HTML-Textkörper ein optionales inlineImages-Feld hinzufügen, wenn Sie Inline-Bilder für Ihre E-Mail haben.
inlineImages	Object	Ein JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (BlobSource) enthält. Dabei wird davon ausgegangen, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält.
name	String	Der Name des Absenders der E‑Mail (Standard: der Name des Nutzers)
noReply	Boolean	true, wenn die E‑Mail von einer generischen „Nicht antworten“-E‑Mail-Adresse gesendet werden soll, um Empfänger davon abzuhalten, auf E‑Mails zu antworten. Diese Option ist nur für Google Workspace-Konten verfügbar, nicht für Gmail-Nutzer.
replyTo	String	Eine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers)

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• sendEmail(recipient, subject, body)

---

setCurrentMessageAccessToken(accessToken)

Legt das Zugriffstoken für die aktuelle Nachricht fest, mit dem das Skript auf die aktuellen GmailMessage-Eigenschaften zugreifen kann.

Diese Methode ist nur für Google Workspace-Add-on-Projekte erforderlich, die Gmail-Bereich für aktuelle Nachrichten verwenden.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

Parameter

Name	Typ	Beschreibung
accessToken	String	Das temporäre Zugriffstoken, das aus einem Aktionsereignisobjekt eines Gmail-Add-ons abgerufen wurde.

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/

---

starMessage(message)

Fügt dieser Nachricht einen Stern hinzu und erzwingt eine Aktualisierung der Nachricht.

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Parameter

Name	Typ	Beschreibung
message	GmailMessage	die Nachricht, die mit einem Stern markiert werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• starMessages(messages)

---

starMessages(messages)

Diesen Nachrichten werden Sterne hinzugefügt und sie werden aktualisiert.

// Stars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parameter

Name	Typ	Beschreibung
messages	GmailMessage[]	Ein Array von Nachrichten, die mit einem Stern markiert werden sollen

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• starMessage(message)

---

unstarMessage(message)

Entfernt die Sternmarkierung aus dieser Nachricht und erzwingt eine Aktualisierung der Nachricht.

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parameter

Name	Typ	Beschreibung
message	GmailMessage	die Nachricht, deren Sternmarkierung aufgehoben werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• unstarMessages(messages)

---

unstarMessages(messages)

Entfernt die Sternmarkierungen aus diesen Nachrichten und erzwingt eine Aktualisierung der Nachrichten.

// Unstars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parameter

Name	Typ	Beschreibung
messages	GmailMessage[]	Ein Array mit Nachrichten, deren Markierung aufgehoben werden soll

Rückflug

GmailApp: Der Gmail-Dienst, der sich gut für das Verketten eignet

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

• unstarMessage(message)

Eingestellte Methoden

getChatThreads()

Veraltet. Diese Funktion ist veraltet und sollte nicht in neuen Skripts verwendet werden.

Ruft alle Unterhaltungen aus dem klassischen Google Hangouts und Google Chat ab, bis Google alle Nutzer des klassischen Hangouts im Laufe des Jahres zu Chat migriert. Weitere Informationen zum Wechsel vom klassischen Hangouts zu Google Chat

Dieser Aufruf schlägt 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 den „paged“-Aufruf und geben Sie in jedem Aufruf Bereiche der abzurufenden Threads an.

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

Rückflug

GmailThread[] – Ein Array von Chat-Threads aus Gmail.

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/

---

getChatThreads(start, max)

Veraltet. Diese Funktion ist veraltet und sollte nicht in neuen Skripts verwendet werden.

Ruft eine Reihe von Threads aus dem klassischen Google Hangouts und Google Chat ab, bis Google alle Nutzer des klassischen Hangouts im Laufe des Jahres zu Chat migriert. Weitere Informationen zum Wechsel vom klassischen Hangouts zu Google Chat

// Get first 50 chat threads
const threads = GmailApp.getChatThreads(0, 50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

Parameter

Name	Typ	Beschreibung
start	Integer	Der Index des ersten abzurufenden Threads.
max	Integer	Die maximale Anzahl der abzurufenden Threads

Rückflug

GmailThread[] – ein Array von Gmail-Chat-Threads

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/