Ermöglicht den Zugriff auf Gmail-Unterhaltungen, -Nachrichten und -Labels.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
create | Gmail | Erstellt einen E-Mail-Entwurf. |
create | Gmail | Erstellt einen E-Mail-Entwurf mit optionalen Argumenten. |
create | Gmail | Erstellen Sie ein neues Nutzerlabel mit dem angegebenen Namen. |
delete | Gmail | Löscht das angegebene Label. |
get | String[] | Eine Liste der E-Mail-Adressen, die in Gmail als Alias 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 | Alle Gmail-Entwurfsnachrichten abrufen |
get | Gmail | Ruft alle Inbox-Unterhaltungen unabhängig von Labels ab. |
get | Gmail | Ruft eine Reihe von Posteingangsthreads unabhängig von Labels ab. |
get | Integer | Die Anzahl der ungelesenen Threads im Posteingang. |
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 unabhängig von Labels ab. |
get | Gmail | Hiermit werden unabhängig von Labels mehrere Threads aus dem sortierten Eingang abgerufen. |
get | Integer | Ermittelt die Anzahl der ungelesenen Threads im sortierten Eingang. |
get | Gmail | Ruft alle Spam-Threads unabhängig von Labels ab. |
get | Gmail | Ruft eine Reihe von Spam-Threads unabhängig von Labels ab. |
get | Integer | Die Anzahl der ungelesenen Threads, die Spam sind. |
get | Gmail | Ruft alle getaggten Threads unabhängig von Labels ab. |
get | Gmail | Hiermit werden unabhängig von Labels eine Reihe von Threads mit angepinnten Beiträgen abgerufen. |
get | Integer | Die Anzahl der ungelesenen Threads, die mit einem Stern markiert sind. |
get | Gmail | Ruft einen Thread nach ID ab. |
get | Gmail | Ruft alle Threads im Papierkorb unabhängig von Labels ab. |
get | Gmail | Hiermit werden unabhängig von Labels mehrere Threads aus dem Papierkorb abgerufen. |
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 | Diese Nachrichten werden als gelesen markiert und die Nachrichten werden aktualisiert. |
mark | Gmail | Diese Nachrichten werden als ungelesen markiert und die Nachrichten werden aktualisiert. |
mark | Gmail | Dieser Thread wird als wichtig markiert und er wird aktualisiert. |
mark | Gmail | Dieser Thread wird als gelesen markiert und er wird aktualisiert. |
mark | Gmail | Dieser Thread wird als unwichtig markiert und er wird aktualisiert. |
mark | Gmail | Dieser Thread wird als ungelesen markiert und er wird aktualisiert. |
mark | Gmail | Diese Threads werden als wichtig markiert und die Threads werden aktualisiert. |
mark | Gmail | Diese Threads werden als gelesen markiert und aktualisiert. |
mark | Gmail | Diese Threads werden als unwichtig markiert und aktualisiert. |
mark | Gmail | Diese Threads werden als ungelesen markiert und aktualisiert. |
move | Gmail | Die Nachricht wird in den Papierkorb verschoben und die Aktualisierung der Nachricht erzwungen. |
move | Gmail | Die angegebenen Nachrichten werden in den Papierkorb verschoben und die Nachrichten werden aktualisiert. |
move | Gmail | Dieser Thread wird ins Archiv verschoben und er wird aktualisiert. |
move | Gmail | Dieser Thread wird in den Posteingang verschoben und er wird aktualisiert. |
move | Gmail | Dieser Thread wird in den Spamordner verschoben und er wird aktualisiert. |
move | Gmail | Der Thread wird in den Papierkorb verschoben und er wird aktualisiert. |
move | Gmail | Diese Threads werden ins Archiv verschoben und aktualisiert. |
move | Gmail | Diese Threads werden in den Posteingang verschoben und die Threads werden aktualisiert. |
move | Gmail | Diese Threads werden in den Spamordner verschoben und die Threads werden aktualisiert. |
move | Gmail | Diese Threads werden in den Papierkorb verschoben und die Threads werden aktualisiert. |
refresh | Gmail | Die Nachricht und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben. |
refresh | Gmail | Die Nachrichten und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben. |
refresh | Gmail | Der Thread und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben. |
refresh | Gmail | Die Threads und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben. |
search(query) | Gmail | In Gmail mit der angegebenen Suchanfrage suchen |
search(query, start, max) | Gmail | In Gmail mit der angegebenen Suchanfrage suchen |
send | Gmail | Eine E-Mail wird gesendet. |
send | Gmail | Sendet eine E-Mail-Nachricht mit optionalen Argumenten. |
set | void | Hier wird das aktuelle Zugriffstoken der Nachricht festgelegt, mit dem das Script auf die aktuellen Gmail -Properties zugreifen kann. |
star | Gmail | Diese Nachricht wird mit einem Sternsymbol gekennzeichnet und die Nachricht wird aktualisiert. |
star | Gmail | Diese Nachrichten werden mit einem Stern markiert und die Nachrichten werden aktualisiert. |
unstar | Gmail | Entfernt einen Stern von dieser Nachricht und aktualisiert sie. |
unstar | Gmail | Die Sterne werden aus diesen Nachrichten entfernt und die Nachrichten werden aktualisiert. |
Detaillierte Dokumentation
create Draft(recipient, subject, body)
Erstellt einen E-Mail-Entwurf. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.
// 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
create Draft(recipient, subject, body, options)
Erstellt einen E-Mail-Entwurf 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 kontingentiert.
// 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 der Empfänger |
subject | String | Betreffzeile |
body | String | im Textkörper der E-Mail |
options | Object | ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
attachments | Blob | eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen |
bcc | String | eine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion |
cc | String | eine durch Kommas getrennte Liste der E-Mail-Adressen, die auf 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 festgelegt, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inline -Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben. |
inline | Object | ein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (String ) zu Bilddaten (Blob ); 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 | den Namen des Absenders der E-Mail (Standard: 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
create Label(name)
Erstellen Sie 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 | den Namen des neuen Labels |
Rückflug
Gmail
– das neu erstellte Label
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
get Aliases()
Eine Liste der E-Mail-Adressen, die in Gmail als Alias für dieses Konto eingerichtet sind.
Sie können eine Nachricht von einem beliebigen dieser Aliasse 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 Aliassen für dieses Konto
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 Funktion 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 zu abrufenden 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 von Gmail-Entwürfen
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Drafts()
Alle Gmail-Entwurfsnachrichten abrufen
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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Inbox Threads()
Ruft alle Inbox-Unterhaltungen unabhängig von Labels ab.
Dieser Aufruf schlägt fehl, wenn die Größe aller Threads für das System zu groß ist. Wenn die Threadgröße unbekannt und potenziell sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie bei jedem Aufruf Bereiche der Threads an, die abgerufen werden sollen.
// 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-Unterhaltungen im Posteingang
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Inbox Threads(start, max)
Ruft eine Reihe 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 | Index des ersten Threads, der abgerufen werden soll |
max | Integer | Die maximale Anzahl der Threads, die abgerufen werden sollen. |
Rückflug
Gmail
– ein Array von Gmail-Unterhaltungen im Posteingang
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Inbox Unread Count()
Die Anzahl der ungelesenen Threads im Posteingang.
Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);
Rückflug
Integer
– die Anzahl der Threads im Posteingang, die ungelesene Nachrichten enthalten
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 Funktion 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 | den Nachrichten-Thread, der abgerufen werden soll |
Rückflug
Gmail
– Array mit Nachrichten, die zu diesem Thread gehören
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 Nachrichtenarrays, 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
get Priority Inbox Threads()
Ruft alle Threads im Sortierten Eingang unabhängig von Labels ab.
Dieser Aufruf schlägt fehl, wenn die Größe aller Threads für das System zu groß ist. Wenn die Threadgröße unbekannt und potenziell sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie bei jedem Aufruf Bereiche der Threads an, die abgerufen werden sollen.
Logger.log( `# of messages in your Priority Inbox: ${ GmailApp.getPriorityInboxThreads().length}`, );
Rückflug
Gmail
– ein Array von Gmail-Unterhaltungen im Sortierten Eingang
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Priority Inbox Threads(start, max)
Hiermit werden unabhängig von Labels mehrere Threads aus dem sortierten Eingang abgerufen.
// 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 | Index des ersten Threads, der abgerufen werden soll |
max | Integer | Die maximale Anzahl der Threads, die abgerufen werden sollen. |
Rückflug
Gmail
– ein Array von Gmail-Unterhaltungen im Sortierten Eingang
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Priority Inbox Unread Count()
Ermittelt die Anzahl der ungelesenen Threads im sortierten Eingang.
Logger.log( `Number of unread emails in your Priority Inbox : ${ GmailApp.getPriorityInboxUnreadCount()}`, );
Rückflug
Integer
– die Anzahl der Threads im Sortierten Eingang, die ungelesene Nachrichten enthalten
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Spam Threads()
Ruft alle Spam-Threads unabhängig von Labels ab.
Dieser Aufruf schlägt fehl, wenn die Größe aller Threads für das System zu groß ist. Wenn die Threadgröße unbekannt und potenziell sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie bei jedem Aufruf Bereiche der Threads an, die abgerufen werden sollen.
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);
Rückflug
Gmail
– ein Array von Gmail-Unterhaltungen im Spamordner
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Spam Threads(start, max)
Ruft eine Reihe 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 | Index des ersten Threads, der abgerufen werden soll |
max | Integer | Die maximale Anzahl der Threads, die abgerufen werden sollen. |
Rückflug
Gmail
– ein Array von Gmail-Unterhaltungen im Spamordner
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Spam Unread Count()
Die Anzahl der ungelesenen Threads, 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-Unterhaltungen mit ungelesenen Nachrichten
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Starred Threads()
Ruft alle getaggten Threads unabhängig von Labels ab.
Dieser Aufruf schlägt fehl, wenn die Größe aller Threads für das System zu groß ist. Wenn die Threadgröße unbekannt und potenziell sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie bei jedem Aufruf Bereiche der Threads an, die abgerufen werden sollen.
// Logs the number of starred threads Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);
Rückflug
Gmail
– eine Reihe von markierten Gmail-Konversationen
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Starred Threads(start, max)
Hiermit werden unabhängig von Labels eine Reihe von Threads mit angepinnten Beiträgen abgerufen.
// 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 | Index des ersten Threads, der abgerufen werden soll |
max | Integer | Die maximale Anzahl der Threads, die abgerufen werden sollen. |
Rückflug
Gmail
– eine Reihe von markierten Gmail-Konversationen
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Starred Unread Count()
Die Anzahl der ungelesenen Threads, die mit einem Stern markiert sind.
Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);
Rückflug
Integer
– die Anzahl der markierten Threads mit ungelesenen Nachrichten
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Thread By Id(id)
Ruft einen Thread nach ID ab.
Verwenden Sie diese Funktion in Verbindung mit getId() für Gmail-Unterhaltungen.
// 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 Threads, der abgerufen werden soll. |
Rückflug
Gmail
: Der Thread mit der angegebenen ID oder null
, falls nicht gefunden.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 für das System zu groß ist. Wenn die Threadgröße unbekannt und potenziell sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie bei jedem Aufruf Bereiche der Threads an, die abgerufen werden sollen.
Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);
Rückflug
Gmail
– eine Reihe von Gmail-Threads im Papierkorb
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
get Trash Threads(start, max)
Hiermit werden unabhängig von Labels mehrere Threads aus dem Papierkorb abgerufen.
// Will log a number at most 5 Logger.log( `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`, );
Parameter
Name | Typ | Beschreibung |
---|---|---|
start | Integer | Index des ersten Threads, der abgerufen werden soll |
max | Integer | Die maximale Anzahl der Threads, die abgerufen werden sollen. |
Rückflug
Gmail
– eine Reihe von Gmail-Threads im Papierkorb
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
mark Messages Read(messages)
Diese Nachrichten werden als gelesen markiert und die Nachrichten werden aktualisiert.
// 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 | eine Reihe von Nachrichten, die als gelesen markiert werden sollen |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
mark Messages Unread(messages)
Diese Nachrichten werden als ungelesen markiert und die Nachrichten werden aktualisiert.
// 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 | eine Reihe von Nachrichten, die als ungelesen markiert werden sollen |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
mark Thread Important(thread)
Dieser Thread wird als wichtig markiert und er wird aktualisiert.
// Marks first inbox thread as important const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | den Thread, den Sie als wichtig markieren möchten |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
mark Thread Read(thread)
Dieser Thread wird als gelesen markiert und er wird aktualisiert.
// Marks first inbox thread as read const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | den Thread, den Sie als gelesen markieren möchten |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
mark Thread Unimportant(thread)
Dieser Thread wird als unwichtig markiert und er wird aktualisiert.
// Marks first inbox thread as unimportant const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | den Thread, den Sie als unwichtig markieren möchten |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
mark Thread Unread(thread)
Dieser Thread wird als ungelesen markiert und er wird aktualisiert.
// Marks first inbox thread as unread const thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | den Thread, den Sie als ungelesen markieren möchten |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
mark Threads Important(threads)
Diese Threads werden als wichtig markiert und die Threads werden aktualisiert.
// Marks first two threads in inbox as important const threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | Gmail | eine Reihe von Threads, die als wichtig markiert werden sollen |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
mark Threads Unimportant(threads)
Diese Threads werden als unwichtig markiert und aktualisiert.
// 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Message To Trash(message)
Die Nachricht wird in den Papierkorb verschoben und die Aktualisierung der Nachricht erzwungen.
// 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 Verknüpfung)
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Messages To Trash(messages)
Die angegebenen Nachrichten werden in den Papierkorb verschoben und die Nachrichten werden aktualisiert.
// 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 Verknüpfung)
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Thread To Archive(thread)
Dieser Thread wird ins Archiv verschoben und er wird aktualisiert.
// Archive the first thread in your inbox const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToArchive(firstThread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | der zu archivierende Thread |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Thread To Inbox(thread)
Dieser Thread wird in den Posteingang verschoben und er wird aktualisiert.
// 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 | den Thread, der in den Posteingang verschoben werden soll |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Thread To Spam(thread)
Dieser Thread wird in den Spamordner verschoben und er wird aktualisiert.
// Tag first thread in inbox as spam const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToSpam(firstThread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | den Thread, der in den Spamordner verschoben werden soll |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Thread To Trash(thread)
Der Thread wird in den Papierkorb verschoben und er wird aktualisiert.
// Move first thread in inbox to trash const firstThread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.moveThreadToTrash(firstThread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | Gmail | den Thread, der gelöscht werden soll |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Threads To Archive(threads)
Diese Threads werden ins Archiv verschoben und aktualisiert.
// 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 Threads, die archiviert werden sollen |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Threads To Inbox(threads)
Diese Threads werden in den Posteingang verschoben und die Threads werden aktualisiert.
// 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Threads To Spam(threads)
Diese Threads werden in den Spamordner verschoben und die Threads werden aktualisiert.
// 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 von Threads, die in den Spamordner verschoben werden sollen |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
move Threads To Trash(threads)
Diese Threads werden in den Papierkorb verschoben und die Threads werden aktualisiert.
// 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
refresh Message(message)
Die Nachricht und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
refresh Messages(messages)
Die Nachrichten und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus 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 Nachrichten, die aktualisiert werden sollen |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
refresh Thread(thread)
Der Thread und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus 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 | den zu aktualisierenden Thread |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
refresh Threads(threads)
Die Threads und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
search(query)
In Gmail mit der angegebenen Suchanfrage suchen
Dieser Aufruf schlägt fehl, wenn die Größe aller Threads für das System zu groß ist. Wenn die Threadgröße unbekannt und potenziell sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie bei jedem Aufruf Bereiche der Threads an, die abgerufen werden sollen.
// 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-Unterhaltungen, die dieser Abfrage entsprechen
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
search(query, start, max)
In Gmail mit der angegebenen Suchanfrage suchen
// 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 | den Index des Startthreads |
max | Integer | Die maximale Anzahl der zurückzugebenden Threads. |
Rückflug
Gmail
: ein Array von Gmail-Unterhaltungen, die dieser Abfrage entsprechen
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
send Email(recipient, subject, body)
Eine E-Mail wird gesendet. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.
// 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 kontingentiert.
// 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 der Empfänger |
subject | String | Betreffzeile (maximal 250 Zeichen) |
body | String | im Textkörper der E-Mail |
options | Object | ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
attachments | Blob | eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen |
bcc | String | eine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion |
cc | String | eine durch Kommas getrennte Liste der E-Mail-Adressen, die auf 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 festgelegt, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inline -Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben. |
inline | Object | ein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (String ) zu Bilddaten (Blob ); 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 | den Namen des Absenders der E-Mail (Standard: Name des Nutzers) |
no | Boolean | true , wenn die E-Mail von einer generischen E-Mail-Adresse ohne Antwortfunktion 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, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
set Current Message Access Token(accessToken)
Hier wird das aktuelle Zugriffstoken der Nachricht festgelegt, mit dem das Script auf die aktuellen Gmail
-Properties zugreifen kann.
Diese Methode ist nur für Google Workspace-Add-on-Projekte erforderlich, die aktuelle Nachrichtenbereiche von Gmail 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 über ein Gmail-Add-on-Ereignisobjekt abgerufen wurde. |
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
star Message(message)
Diese Nachricht wird mit einem Sternsymbol gekennzeichnet und die Nachricht wird aktualisiert.
// 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 Sie markieren möchten |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
star Messages(messages)
Diese Nachrichten werden mit einem Stern markiert und die Nachrichten 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 | eine Reihe von Nachrichten, die mit einem Stern markiert werden sollen |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
unstar Message(message)
Entfernt einen Stern von dieser Nachricht und aktualisiert sie.
// 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 Markierung aufgehoben werden soll |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
unstar Messages(messages)
Die Sterne werden aus diesen Nachrichten entfernt und die Nachrichten werden aktualisiert.
// 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 | eine Reihe von Nachrichten, bei denen die Markierung aufgehoben werden soll |
Rückflug
Gmail
– der Gmail-Dienst, nützlich für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/