Bietet Zugriff auf Gmail-Konversationen, ‑Nachrichten und ‑Labels.
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
create | Gmail | Erstellt einen E‑Mail-Entwurf. |
create | Gmail | Erstellt eine E‑Mail-Nachricht als Entwurf mit optionalen Argumenten. |
create | Gmail | Erstellt ein neues Nutzerlabel mit dem angegebenen Namen. |
delete | Gmail | Löscht das angegebene Label. |
get | String[] | Ruft eine Liste der E‑Mail-Adressen ab, die in Gmail als Aliase für dieses Konto eingerichtet sind. |
get | Gmail | E‑Mail-Entwurf anhand der ID abrufen |
get | Gmail | Ruft alle E‑Mail-Entwürfe ab. |
get | Gmail | Ruft alle Gmail-Nachrichtenentwürfe ab. |
get | Gmail | Ruft alle Inbox-Konversationen unabhängig von Labels ab. |
get | Gmail | Ruft einen Bereich von Posteingangsthreads unabhängig von Labels ab. |
get | Integer | Ruft die Anzahl der ungelesenen Threads im Posteingang ab. |
get | Gmail | Ruft eine Nachricht anhand der ID ab. |
get | Gmail | Alle Nachrichten im angegebenen Thread abrufen. |
get | Gmail | Alle Nachrichten in den angegebenen Threads abrufen. |
get | Gmail | Ruft alle Threads im sortierten Eingang ab, unabhängig von Labels. |
get | Gmail | Ruft eine Reihe von Konversationen im sortierten Eingang unabhängig von Labels ab. |
get | Integer | Ruft die Anzahl der ungelesenen Unterhaltungen im sortierten Eingang ab. |
get | Gmail | Ruft alle Spam-Konversationen unabhängig von Labels ab. |
get | Gmail | Ruft einen Bereich von Spam-Threads unabhängig von Labels ab. |
get | Integer | Ruft die Anzahl der ungelesenen Threads ab, die Spam sind. |
get | Gmail | Ruft alle mit Sternchen markierten Threads unabhängig von Labels ab. |
get | Gmail | Ruft einen Bereich mit markierten Threads unabhängig von Labels ab. |
get | Integer | Ruft die Anzahl der ungelesenen Threads ab, die mit einem Sternchen markiert sind. |
get | Gmail | Ruft einen Thread nach ID ab. |
get | Gmail | Ruft alle Threads im Papierkorb unabhängig von Labels ab. |
get | Gmail | Ruft einen Bereich von gelöschten Threads unabhängig von Labels ab. |
get | Gmail | Ruft ein Label anhand des Labelnamens ab. |
get | Gmail | Ruft eine Liste der vom Nutzer erstellten Labels ab. |
mark | Gmail | Diese Nachricht wird als gelesen markiert und die Nachricht wird aktualisiert. |
mark | Gmail | Diese Nachricht wird als ungelesen markiert und die Nachricht wird aktualisiert. |
mark | Gmail | Markiert diese Nachrichten als gelesen und erzwingt eine Aktualisierung der Nachrichten. |
mark | Gmail | Markiert diese Nachrichten als ungelesen und erzwingt eine Aktualisierung der Nachrichten. |
mark | Gmail | Markiert diesen Thread als wichtig und erzwingt eine Aktualisierung des Threads. |
mark | Gmail | Markiert diesen Thread als gelesen und erzwingt eine Aktualisierung des Threads. |
mark | Gmail | Markiert diesen Thread als unwichtig und erzwingt eine Aktualisierung des Threads. |
mark | Gmail | Markiert diesen Thread als ungelesen und erzwingt eine Aktualisierung des Threads. |
mark | Gmail | Markiert diese Threads als wichtig und erzwingt, dass sie aktualisiert werden. |
mark | Gmail | Diese Threads werden als gelesen markiert und aktualisiert. |
mark | Gmail | Markiert diese Threads als unwichtig und erzwingt, dass sie aktualisiert werden. |
mark | Gmail | Diese Threads werden als ungelesen markiert und aktualisiert. |
move | Gmail | Verschiebt die Nachricht in den Papierkorb und erzwingt eine Aktualisierung der Nachricht. |
move | Gmail | Verschiebt die angegebenen Nachrichten in den Papierkorb und erzwingt eine Aktualisierung der Nachrichten. |
move | Gmail | Verschiebt diesen Thread ins Archiv und erzwingt eine Aktualisierung des Threads. |
move | Gmail | Verschiebt diesen Thread in den Posteingang und erzwingt eine Aktualisierung des Threads. |
move | Gmail | Verschiebt diesen Thread in den Spamordner und erzwingt eine Aktualisierung des Threads. |
move | Gmail | Verschiebt diesen Thread in den Papierkorb und erzwingt eine Aktualisierung des Threads. |
move | Gmail | Verschiebt diese Threads ins Archiv und erzwingt, dass die Threads aktualisiert werden. |
move | Gmail | Verschiebt diese Threads in den Posteingang und erzwingt eine Aktualisierung der Threads. |
move | Gmail | Verschiebt diese Threads in den Spamordner und erzwingt eine Aktualisierung der Threads. |
move | Gmail | Verschiebt diese Threads in den Papierkorb und erzwingt eine Aktualisierung der Threads. |
refresh | Gmail | Lädt die Nachricht und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben). |
refresh | Gmail | Lädt die Nachrichten und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben). |
refresh | Gmail | Lädt den Thread und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben). |
refresh | Gmail | 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) | Gmail | Suchen Sie in Gmail mit der angegebenen Anfrage. |
search(query, start, max) | Gmail | Suchen Sie in Gmail mit der angegebenen Anfrage. |
send | Gmail | Sendet eine E‑Mail-Nachricht. |
send | Gmail | Sendet eine E‑Mail-Nachricht mit optionalen Argumenten. |
set | void | Legt das Zugriffstoken für die aktuelle Nachricht fest, mit dem das Skript auf die aktuellen Gmail-Eigenschaften zugreifen kann. |
star | Gmail | Fügt dieser Nachricht einen Stern hinzu und erzwingt eine Aktualisierung der Nachricht. |
star | Gmail | Diesen Nachrichten werden Sterne hinzugefügt und sie werden aktualisiert. |
unstar | Gmail | Entfernt die Sternmarkierung aus dieser Nachricht und erzwingt eine Aktualisierung der Nachricht. |
unstar | Gmail | Entfernt die Sternmarkierungen aus diesen Nachrichten und erzwingt eine Aktualisierung der Nachrichten. |
Detaillierte Dokumentation
create Draft(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( 'mike@example.com', '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
Gmail – 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
create Draft(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( 'mike@example.com', '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 | Blob | 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 get zurückgegebenen Werte sein. |
html | 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 inline-Feld hinzufügen, wenn Sie Inline-Bilder für Ihre E-Mail haben. |
inline | Object | Ein JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (Blob) enthält. Dabei wird davon ausgegangen, dass der Parameter html 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) |
reply | String | Eine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers) |
Rückflug
Gmail – 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
create Label(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
Gmail: 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
delete Label(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 | Gmail | Das zu löschende Label |
Rückflug
Gmail: 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
get Aliases()
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
get Draft(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 |
|---|---|---|
draft | String | die ID des abzurufenden Entwurfs |
Rückflug
Gmail: 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/
get Draft Messages()
Ruft alle E‑Mail-Entwürfe ab.
// Logs the number of draft messages const drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
Rückflug
Gmail – 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/
get Drafts()
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
Gmail – 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/
get Inbox Threads()
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
Gmail – 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/
get Inbox Threads(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
Gmail – 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/
get Inbox Unread Count()
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/
get Message By Id(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
Gmail: 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
get Messages For Thread(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 | Gmail | der abzurufende Nachrichtenverlauf |
Rückflug
Gmail – 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
get Messages For Threads(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 | Gmail | die Threads der abzurufenden Nachrichten |
Rückflug
Gmail: 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
get Priority Inbox Threads()
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
Gmail – 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/
get Priority Inbox Threads(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
Gmail – 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/
get Priority Inbox Unread Count()
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/
get Spam Threads()
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
Gmail – 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/
get Spam Threads(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
Gmail – 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/
get Spam Unread Count()
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/
get Starred Threads()
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
Gmail – 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/
get Starred Threads(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
Gmail – 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/
get Starred Unread Count()
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/
get Thread By Id(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
Gmail – 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
get Trash Threads()
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
Gmail – 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/
get Trash Threads(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
Gmail – 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/
get User Label By Name(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
Gmail: 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/
get User Labels()
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
Gmail – 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/
mark Message Read(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 | Gmail | die Nachricht, die als gelesen markiert werden soll |
Rückflug
Gmail: 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
mark Message Unread(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 | Gmail | die Nachricht, die als ungelesen markiert werden soll |
Rückflug
Gmail: 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
mark Messages Read(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 | Gmail | Ein Array von Nachrichten, die als gelesen markiert werden sollen |
Rückflug
Gmail: 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
mark Messages Unread(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 | Gmail | Ein Array von Nachrichten, die als ungelesen markiert werden sollen |
Rückflug
Gmail: 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
mark Thread Important(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 | Gmail | die Unterhaltung, die Sie als wichtig markieren möchten |
Rückflug
Gmail: 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
mark Thread Read(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 | Gmail | Der Thread, der als gelesen markiert werden soll |
Rückflug
Gmail: 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
mark Thread Unimportant(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 | Gmail | den Thread, der als unwichtig markiert werden soll |
Rückflug
Gmail: 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
mark Thread Unread(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 | Gmail | Der Thread, der als ungelesen markiert werden soll |
Rückflug
Gmail: 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
mark Threads Important(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 | Gmail | Ein Array von Threads, die als wichtig markiert werden sollen |
Rückflug
Gmail: 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
mark Threads Read(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 | Gmail | Ein Array von Threads, die als gelesen markiert werden sollen |
Rückflug
Gmail: 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
mark Threads Unimportant(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 | Gmail | Ein Array von Threads, die als unwichtig markiert werden sollen |
Rückflug
Gmail: 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
mark Threads Unread(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 | Gmail | Ein Array von Threads, die als ungelesen markiert werden sollen |
Rückflug
Gmail: 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
move Message To Trash(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 | Gmail | Die Nachricht, die in den Papierkorb verschoben werden soll |
Rückflug
Gmail – 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
move Messages To Trash(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 | Gmail | die Nachrichten, die in den Papierkorb verschoben werden sollen |
Rückflug
Gmail – 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
move Thread To Archive(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 | Gmail | Die zu archivierende Unterhaltung |
Rückflug
Gmail: 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
move Thread To Inbox(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 | Gmail | die Konversation, die in den Posteingang verschoben werden soll |
Rückflug
Gmail: 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
move Thread To Spam(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 | Gmail | Die Unterhaltung, die in den Spamordner verschoben werden soll |
Rückflug
Gmail: 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
move Thread To Trash(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 | Gmail | der zu löschende Thread |
Rückflug
Gmail: 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
move Threads To Archive(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 | Gmail | Ein Array von zu archivierenden Threads |
Rückflug
Gmail: 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
move Threads To Inbox(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 | Gmail | Ein Array von Threads, die in den Posteingang verschoben werden sollen |
Rückflug
Gmail: 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
move Threads To Spam(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 | Gmail | Ein Array mit Threads, die in den Spamordner verschoben werden sollen |
Rückflug
Gmail: 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
move Threads To Trash(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 | Gmail | Ein Array von Threads, die in den Papierkorb verschoben werden sollen |
Rückflug
Gmail: 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
refresh Message(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 | Gmail | Die Nachricht, die aktualisiert werden soll |
Rückflug
Gmail: 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
refresh Messages(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 | Gmail | die zu aktualisierenden Nachrichten |
Rückflug
Gmail: 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
refresh Thread(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 | Gmail | der zu aktualisierende Thread |
Rückflug
Gmail: 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
refresh Threads(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 | Gmail | Die zu aktualisierenden Threads |
Rückflug
Gmail: 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
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
Gmail – 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
Gmail – 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/
send Email(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( 'mike@example.com', '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
Gmail: 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
send Email(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( 'mike@example.com', '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 | Blob | 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 get zurückgegebenen Werte sein. |
html | 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 inline-Feld hinzufügen, wenn Sie Inline-Bilder für Ihre E-Mail haben. |
inline | Object | Ein JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (Blob) enthält. Dabei wird davon ausgegangen, dass der Parameter html 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) |
no | 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. |
reply | String | Eine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers) |
Rückflug
Gmail: 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
set Current Message Access Token(accessToken)
Legt das Zugriffstoken für die aktuelle Nachricht fest, mit dem das Skript auf die aktuellen Gmail-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 |
|---|---|---|
access | 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/
star Message(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 | Gmail | die Nachricht, die mit einem Stern markiert werden soll |
Rückflug
Gmail: 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
star Messages(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 | Gmail | Ein Array von Nachrichten, die mit einem Stern markiert werden sollen |
Rückflug
Gmail: 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
unstar Message(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 | Gmail | die Nachricht, deren Sternmarkierung aufgehoben werden soll |
Rückflug
Gmail: 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
unstar Messages(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 | Gmail | Ein Array mit Nachrichten, deren Markierung aufgehoben werden soll |
Rückflug
Gmail: 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/