Bietet Zugriff auf Gmail-Threads, -Nachrichten und -Labels.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
createDraft(recipient, subject, body) | GmailDraft | Damit wird ein Entwurf für eine E-Mail-Nachricht erstellt. |
createDraft(recipient, subject, body, options) | GmailDraft | Erstellt einen E-Mail-Entwurf mit optionalen Argumenten. |
createLabel(name) | GmailLabel | Erstellt ein neues Nutzerlabel mit dem angegebenen Namen. |
deleteLabel(label) | GmailApp | Löscht das angegebene Label. |
getAliases() | String[] | Ruft eine Liste der E-Mail-Adressen ab, die als Aliasse für dieses Konto in Gmail eingerichtet sind. |
getDraft(draftId) | GmailDraft | E-Mail-Entwurf nach ID abrufen |
getDraftMessages() | GmailMessage[] | Ruft alle Nachrichtenentwürfe ab. |
getDrafts() | GmailDraft[] | Ruft alle Gmail-Entwürfe ab. |
getInboxThreads() | GmailThread[] | Ruft alle Posteingangsthreads unabhängig von den Labels ab. |
getInboxThreads(start, max) | GmailThread[] | Ruft einen Bereich von Posteingangsthreads unabhängig von den Labels ab. |
getInboxUnreadCount() | Integer | Ruft die Anzahl der ungelesenen Threads im Posteingang ab. |
getMessageById(id) | GmailMessage | Ruft eine Nachricht nach ID ab. |
getMessagesForThread(thread) | GmailMessage[] | Ruft alle Nachrichten im angegebenen Thread ab. |
getMessagesForThreads(threads) | GmailMessage[][] | Ruft alle Nachrichten in den angegebenen Threads ab. |
getPriorityInboxThreads() | GmailThread[] | Ruft alle Threads im sortierten Eingang ab, unabhängig von den Labels. |
getPriorityInboxThreads(start, max) | GmailThread[] | Ruft einen Bereich von Threads im sortierten Eingang ab, unabhängig von den Labels. |
getPriorityInboxUnreadCount() | Integer | Ruft die Anzahl der ungelesenen Threads im sortierten Eingang ab. |
getSpamThreads() | GmailThread[] | Ruft alle Spam-Threads unabhängig von den Labels ab. |
getSpamThreads(start, max) | GmailThread[] | Ruft einen Bereich von Spam-Threads unabhängig von den Labels ab. |
getSpamUnreadCount() | Integer | Ruft die Anzahl der ungelesenen Threads ab, bei denen es sich um Spam handelt. |
getStarredThreads() | GmailThread[] | Ruft alle markierten Threads unabhängig von den Labels ab. |
getStarredThreads(start, max) | GmailThread[] | Ruft einen Bereich markierter Threads unabhängig von den Labels ab. |
getStarredUnreadCount() | Integer | Ruft die Anzahl der ungelesenen Threads ab, die markiert sind. |
getThreadById(id) | GmailThread | Ruft einen Thread nach ID ab. |
getTrashThreads() | GmailThread[] | Ruft alle Papierkorb-Threads unabhängig von den Labels ab. |
getTrashThreads(start, max) | GmailThread[] | Ruft einen Bereich von Papierkorb-Threads unabhängig von den Labels ab. |
getUserLabelByName(name) | GmailLabel | Ruft ein Label anhand des Labelnamens ab. |
getUserLabels() | GmailLabel[] | Ruft eine Liste der vom Nutzer erstellten Labels ab. |
markMessageRead(message) | GmailApp | Die Nachricht wird als gelesen markiert und erzwingt die Aktualisierung der Nachricht. |
markMessageUnread(message) | GmailApp | Diese Nachricht wird als ungelesen markiert und eine Aktualisierung der Nachricht wird erzwungen. |
markMessagesRead(messages) | GmailApp | Die Nachrichten werden als gelesen markiert und eine Aktualisierung wird erzwungen. |
markMessagesUnread(messages) | GmailApp | Diese Nachrichten werden als ungelesen markiert und eine Aktualisierung wird erzwungen. |
markThreadImportant(thread) | GmailApp | Kennzeichnet diesen Thread als wichtig und erzwingt eine Aktualisierung des Threads. |
markThreadRead(thread) | GmailApp | Kennzeichnet diesen Thread als gelesen und erzwingt eine Aktualisierung des Threads. |
markThreadUnimportant(thread) | GmailApp | Kennzeichnet diesen Thread als unwichtig und erzwingt eine Aktualisierung des Threads. |
markThreadUnread(thread) | GmailApp | Kennzeichnet diesen Thread als ungelesen und erzwingt eine Aktualisierung des Threads. |
markThreadsImportant(threads) | GmailApp | Kennzeichnet diese Threads als wichtig und erzwingt eine Aktualisierung. |
markThreadsRead(threads) | GmailApp | Markiert diese Threads als gelesen und erzwingt eine Aktualisierung der Threads. |
markThreadsUnimportant(threads) | GmailApp | Kennzeichnet diese Threads als unwichtig und erzwingt eine Aktualisierung der Threads. |
markThreadsUnread(threads) | GmailApp | Dadurch werden diese Threads als ungelesen markiert und ihre Aktualisierung erzwungen. |
moveMessageToTrash(message) | GmailApp | Die Nachricht wird in den Papierkorb verschoben und eine Aktualisierung wird erzwungen. |
moveMessagesToTrash(messages) | GmailApp | Die angegebenen Nachrichten werden in den Papierkorb verschoben und eine Aktualisierung wird erzwungen. |
moveThreadToArchive(thread) | GmailApp | Verschiebt diesen Thread in das Archiv und erzwingt eine Aktualisierung des Threads. |
moveThreadToInbox(thread) | GmailApp | Verschiebt diesen Thread in den Posteingang und erzwingt eine Aktualisierung des Threads. |
moveThreadToSpam(thread) | GmailApp | Verschiebt diesen Thread in den Spamordner und erzwingt eine Aktualisierung. |
moveThreadToTrash(thread) | GmailApp | Verschiebt diesen Thread in den Papierkorb und erzwingt eine Aktualisierung. |
moveThreadsToArchive(threads) | GmailApp | Verschiebt diese Threads in das Archiv und erzwingt eine Aktualisierung der Threads. |
moveThreadsToInbox(threads) | GmailApp | Verschiebt diese Threads in den Posteingang und erzwingt eine Aktualisierung der Threads. |
moveThreadsToSpam(threads) | GmailApp | Diese Threads werden in den Spamordner verschoben und die Threads werden aktualisiert. |
moveThreadsToTrash(threads) | GmailApp | Verschiebt diese Threads in den Papierkorb und erzwingt eine Aktualisierung. |
refreshMessage(message) | GmailApp | Lädt die Nachricht und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben) |
refreshMessages(messages) | GmailApp | Lädt die Nachrichten und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben) |
refreshThread(thread) | GmailApp | Lädt den Thread und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben). |
refreshThreads(threads) | GmailApp | Lädt die Threads und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben). |
search(query) | GmailThread[] | Suchen Sie in Gmail mit der angegebenen Suchanfrage. |
search(query, start, max) | GmailThread[] | Suchen Sie in Gmail mit der angegebenen Suchanfrage. |
sendEmail(recipient, subject, body) | GmailApp | Sendet eine E-Mail-Nachricht. |
sendEmail(recipient, subject, body, options) | GmailApp | Sendet eine E-Mail-Nachricht mit optionalen Argumenten. |
setCurrentMessageAccessToken(accessToken) | void | Legt das aktuelle Zugriffstoken für die Nachricht fest, mit dem das Skript auf die aktuellen GmailMessage -Attribute zugreifen kann. |
starMessage(message) | GmailApp | Diese Nachricht wird mit einem Stern markiert und die Aktualisierung wird erzwungen. |
starMessages(messages) | GmailApp | Diese Nachrichten werden mit einem Stern markiert und die Nachrichten werden aktualisiert. |
unstarMessage(message) | GmailApp | Die Nachricht wird nicht mit einem Stern markiert und sie wird aktualisiert. |
unstarMessages(messages) | GmailApp | Die Nachrichten werden mit einem Stern markiert und die Nachrichten werden aktualisiert. |
Detaillierte Dokumentation
createDraft(recipient, subject, body)
Damit wird ein Entwurf für eine E-Mail-Nachricht erstellt. Die Größe der E-Mail (einschließlich Header) ist begrenzt.
// The code below creates a draft email with the current date and time. var 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 von E-Mail-Adressen |
subject | String | Betreff der E-Mail |
body | String | E-Mail-Text |
Return
GmailDraft
– der neu erstellte GmailDraft
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
createDraft(recipient, subject, body, options)
Erstellt einen E-Mail-Entwurf mit optionalen Argumenten. Die E-Mail kann nur Text oder HTML-Text enthalten. Die Größe der E-Mail (einschließlich Header, aber ohne Anhänge) ist begrenzt.
// Create a draft email with a file from Google Drive attached as a PDF. var 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 | in der Betreffzeile |
body | String | Der E-Mail-Text |
options | Object | Ein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
attachments | BlobSource[] | Ein Array von Dateien, die mit der E-Mail gesendet werden sollen |
bcc | String | eine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc |
cc | String | eine durch Kommas getrennte Liste von E-Mail-Adressen, die in Cc gesetzt werden sollen |
from | String | Die Adresse, von der die E-Mail gesendet werden soll. Diese muss einer der von getAliases() zurückgegebenen Werte sein. |
htmlBody | String | Ist die Richtlinie festgelegt, verwenden Geräte, die HTML rendern können, dieses Argument anstelle des erforderlichen Textarguments. Wenn du Inline-Bilder für deine E-Mail hast, kannst du ein optionales inlineImages -Feld im HTML-Text hinzufügen. |
inlineImages | Object | Ein JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String ) zu Bilddaten (BlobSource ) enthält. Dabei wird davon ausgegangen, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält. |
name | String | den Namen des Absenders der E-Mail (Standard: der Name des Nutzers) |
replyTo | String | eine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers) |
Return
GmailDraft
– der neu erstellte GmailDraft
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
createLabel(name)
Erstellt ein neues Nutzerlabel mit dem angegebenen Namen.
// Creates the label @FOO and logs label: FOO Logger.log("label: " + GmailApp.createLabel("FOO"));
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des neuen Labels |
Return
GmailLabel
: das neu erstellte Label
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
deleteLabel(label)
Löscht das angegebene Label.
// Have to get the label by name first var label = GmailApp.getUserLabelByName("FOO"); GmailApp.deleteLabel(label);
Parameter
Name | Typ | Beschreibung |
---|---|---|
label | GmailLabel | das zu löschende Label |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
getAliases()
Ruft eine Liste der E-Mail-Adressen ab, die als Aliasse für dieses Konto in Gmail eingerichtet sind.
Sie können eine Nachricht von jedem 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. var me = Session.getActiveUser().getEmail(); var 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.'); }
Return
String[]
: ein Array mit Aliassen für dieses Konto
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
getDraft(draftId)
E-Mail-Entwurf nach ID abrufen
Verwenden Sie dieses Tag in Verbindung mit getId() für Gmail-Entwürfe.
// Get the first draft message in your drafts folder var draft = GmailApp.getDrafts()[0]; // Get its ID var draftId = draft.getId(); // Now fetch the same draft using that ID. var draftById = GmailApp.getDraft(draftId); // Should always log true as they should be the same message Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());
Parameter
Name | Typ | Beschreibung |
---|---|---|
draftId | String | Die ID des abzurufenden Entwurfs |
Return
GmailDraft
: der Entwurf mit der angegebenen ID
Löst aus
Error
– wenn kein Entwurf mit der angegebenen ID gefunden werden kann
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getDraftMessages()
Ruft alle Nachrichtenentwürfe ab.
// Logs the number of draft messages var drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
Return
GmailMessage[]
– ein Array von Gmail-Entwürfen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getDrafts()
Ruft alle Gmail-Entwürfe ab.
var drafts = GmailApp.getDrafts(); for (var i = 0; i < drafts.length; i++) { Logger.log(drafts[i].getId()); }
Return
GmailDraft[]
– ein Array mit Gmail-Entwürfen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getInboxThreads()
Ruft alle Posteingangsthreads unabhängig von den Labels ab.
Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Ist die Threadgröße unbekannt und potenziell sehr groß, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.
// Log the subject lines of your Inbox var threads = GmailApp.getInboxThreads(); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Return
GmailThread[]
– ein Array von Gmail-Threads im Posteingang
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getInboxThreads(start, max)
Ruft einen Bereich von Posteingangsthreads unabhängig von den Labels ab.
// Log the subject lines of up to the first 50 emails in your Inbox var threads = GmailApp.getInboxThreads(0, 50); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
start | Integer | Index des ersten abzurufenden Threads |
max | Integer | die maximale Anzahl abzurufender Threads |
Return
GmailThread[]
– ein Array von Gmail-Threads im Posteingang
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getInboxUnreadCount()
Ruft die Anzahl der ungelesenen Threads im Posteingang ab.
Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());
Return
Integer
– die Anzahl der Threads im Posteingang, die ungelesene Nachrichten enthalten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getMessageById(id)
Ruft eine Nachricht nach ID ab.
Verwenden Sie diesen Parameter in Verbindung mit getId() für Gmail-Nachrichten.
// Get the first message in the first thread of your inbox var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; // Get its ID var messageId = message.getId(); // Now fetch the same message using that ID. var 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 | ID der abzurufenden Nachricht |
Return
GmailMessage
: die Nachricht mit der angegebenen ID
Löst aus
Error
: Wenn keine Nachricht mit der angegebenen ID gefunden wird
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
getMessagesForThread(thread)
Ruft alle Nachrichten im angegebenen Thread ab.
// Log all the subject lines in the first thread of your inbox var thread = GmailApp.getInboxThreads(0, 1)[0]; var messages = GmailApp.getMessagesForThread(thread); for (var i = 0 ; i < messages.length; i++) { Logger.log("subject: " + messages[i].getSubject()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | den Thread der abzurufenden Nachrichten |
Return
GmailMessage[]
: Array der Nachrichten für diesen Thread
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
getMessagesForThreads(threads)
Ruft alle Nachrichten in den angegebenen Threads ab.
// Log the subject lines of all messages in the first two threads of your inbox var thread = GmailApp.getInboxThreads(0, 2); var messages = GmailApp.getMessagesForThreads(thread); for (var i = 0 ; i < messages.length; i++) { for (var j = 0; j < messages[i].length; j++) { Logger.log("subject: " + messages[i][j].getSubject()); } }
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | die Threads der abzurufenden Nachrichten |
Return
GmailMessage[][]
: ein Array aus Nachrichtenarrays, wobei jedes Element im äußeren Array einem Thread entspricht und das innere Array die Nachrichten in diesem Thread enthält
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
getPriorityInboxThreads()
Ruft alle Threads im sortierten Eingang ab, unabhängig von den Labels.
Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Ist die Threadgröße unbekannt und potenziell sehr groß, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.
Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads().length);
Return
GmailThread[]
– eine Reihe von Gmail-Threads im sortierten Eingang
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getPriorityInboxThreads(start, max)
Ruft einen Bereich von Threads im sortierten Eingang ab, unabhängig von den Labels.
// 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 abzurufenden Threads |
max | Integer | die maximale Anzahl abzurufender Threads |
Return
GmailThread[]
– eine Reihe von Gmail-Threads im sortierten Eingang
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getPriorityInboxUnreadCount()
Ruft die Anzahl der ungelesenen Threads im sortierten Eingang ab.
Logger.log("Number of unread emails in your Priority Inbox : " + GmailApp.getPriorityInboxUnreadCount());
Return
Integer
– die Anzahl der Threads im sortierten Eingang, die ungelesene Nachrichten enthalten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getSpamThreads()
Ruft alle Spam-Threads unabhängig von den Labels ab.
Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Ist die Threadgröße unbekannt und potenziell sehr groß, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);
Return
GmailThread[]
: ein Array von Gmail-Threads im Spamordner
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getSpamThreads(start, max)
Ruft einen Bereich von Spam-Threads unabhängig von den 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 abzurufenden Threads |
max | Integer | die maximale Anzahl abzurufender Threads |
Return
GmailThread[]
: ein Array von Gmail-Threads im Spamordner
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getSpamUnreadCount()
Ruft die Anzahl der ungelesenen Threads ab, bei denen es sich um Spam handelt.
// 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());
Return
Integer
– die Anzahl der Spam-Threads mit ungelesenen Nachrichten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getStarredThreads()
Ruft alle markierten Threads unabhängig von den Labels ab.
Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Ist die Threadgröße unbekannt und potenziell sehr groß, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.
// Logs the number of starred threads Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);
Return
GmailThread[]
– ein Array markierter Gmail-Threads
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getStarredThreads(start, max)
Ruft einen Bereich markierter Threads unabhängig von den 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 | Index des ersten abzurufenden Threads |
max | Integer | die maximale Anzahl abzurufender Threads |
Return
GmailThread[]
– ein Array markierter Gmail-Threads
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getStarredUnreadCount()
Ruft die Anzahl der ungelesenen Threads ab, die markiert sind.
Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());
Return
Integer
: die Anzahl der markierten Threads mit ungelesenen Nachrichten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getThreadById(id)
Ruft einen Thread nach ID ab.
Verwenden Sie dies in Verbindung mit getId() für Gmail-Threads.
// 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. |
Return
GmailThread
: Der Thread mit der angegebenen ID oder null
, wenn er nicht gefunden wird.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
getTrashThreads()
Ruft alle Papierkorb-Threads unabhängig von den Labels ab.
Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Ist die Threadgröße unbekannt und potenziell sehr groß, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);
Return
GmailThread[]
– ein Array von Gmail-Threads im Papierkorb
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getTrashThreads(start, max)
Ruft einen Bereich von Papierkorb-Threads unabhängig von den 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 | Index des ersten abzurufenden Threads |
max | Integer | die maximale Anzahl abzurufender Threads |
Return
GmailThread[]
– ein Array von Gmail-Threads im Papierkorb
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getUserLabelByName(name)
Ruft ein Label anhand des Labelnamens ab.
var labelObject = GmailApp.getUserLabelByName("myLabel");
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des abzurufenden Labels |
Return
GmailLabel
: das Gmail-Label mit dem angegebenen Namen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
getUserLabels()
Ruft eine Liste der vom Nutzer erstellten Labels ab.
// Logs all of the names of your labels var labels = GmailApp.getUserLabels(); for (var i = 0; i < labels.length; i++) { Logger.log("label: " + labels[i].getName()); }
Return
GmailLabel[]
: Array mit von Nutzern erstellten Labels
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
markMessageRead(message)
Die Nachricht wird als gelesen markiert und erzwingt die Aktualisierung der Nachricht.
// Mark the first message in the first thread of your inbox as read var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageRead(message);
Parameter
Name | Typ | Beschreibung |
---|---|---|
message | GmailMessage | die Nachricht, die als gelesen markiert werden soll |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markMessageUnread(message)
Diese Nachricht wird als ungelesen markiert und eine Aktualisierung der Nachricht wird erzwungen.
// Mark the first message in the first thread of your inbox as unread var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageUnread(message);
Parameter
Name | Typ | Beschreibung |
---|---|---|
message | GmailMessage | die Nachricht, die als ungelesen markiert werden soll |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markMessagesRead(messages)
Die Nachrichten werden als gelesen markiert und eine Aktualisierung wird erzwungen.
// Mark first three messages in the first inbox thread as read. // Assumes that the first inbox thread has 3 messages in it. var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(thread.getMessages());
Parameter
Name | Typ | Beschreibung |
---|---|---|
messages | GmailMessage[] | Array mit Nachrichten, die als gelesen markiert werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markMessagesUnread(messages)
Diese Nachrichten werden als ungelesen markiert und eine Aktualisierung wird erzwungen.
// Mark first three messages in the first inbox thread as unread. // Assumes that the first inbox thread has 3 messages in it var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesUnread(thread.getMessages());
Parameter
Name | Typ | Beschreibung |
---|---|---|
messages | GmailMessage[] | ein Array von Nachrichten, die als ungelesen markiert werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markThreadImportant(thread)
Kennzeichnet diesen Thread als wichtig und erzwingt eine Aktualisierung des Threads.
// Marks first inbox thread as important var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | den Thread als wichtig markieren, |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markThreadRead(thread)
Kennzeichnet diesen Thread als gelesen und erzwingt eine Aktualisierung des Threads.
// Marks first inbox thread as read var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | Thread, das als gelesen markiert werden soll |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markThreadUnimportant(thread)
Kennzeichnet diesen Thread als unwichtig und erzwingt eine Aktualisierung des Threads.
// Marks first inbox thread as unimportant var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | den Thread als unwichtig markieren |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markThreadUnread(thread)
Kennzeichnet diesen Thread als ungelesen und erzwingt eine Aktualisierung des Threads.
// Marks first inbox thread as unread var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | den Thread, der als ungelesen markiert werden soll |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markThreadsImportant(threads)
Kennzeichnet diese Threads als wichtig und erzwingt eine Aktualisierung.
// Marks first two threads in inbox as important var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | Ein Array von Threads, die als wichtig markiert werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markThreadsRead(threads)
Markiert diese Threads als gelesen und erzwingt eine Aktualisierung der Threads.
// Marks first two threads in inbox as read var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | Ein Array von Threads, die als gelesen markiert werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markThreadsUnimportant(threads)
Kennzeichnet diese Threads als unwichtig und erzwingt eine Aktualisierung der Threads.
// Marks first two threads in inbox as unimportant var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | Ein Array von Threads, die als unwichtig markiert werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
markThreadsUnread(threads)
Dadurch werden diese Threads als ungelesen markiert und ihre Aktualisierung erzwungen.
// Marks first two threads in inbox as unread var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | Ein Array von Threads, die als ungelesen markiert werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveMessageToTrash(message)
Die Nachricht wird in den Papierkorb verschoben und eine Aktualisierung wird erzwungen.
// Move the first message in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; GmailApp.moveMessageToTrash(firstMessage);
Parameter
Name | Typ | Beschreibung |
---|---|---|
message | GmailMessage | die Nachricht, die in den Papierkorb verschoben werden soll |
Return
GmailApp
– der Gmail-Dienst (nützlich für Verkettungen)
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveMessagesToTrash(messages)
Die angegebenen Nachrichten werden in den Papierkorb verschoben und eine Aktualisierung wird erzwungen.
// Move first two messages in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var messages = firstThread.getMessages(); var toDelete = [messages[0], messages[1]]; GmailApp.moveMessagesToTrash(toDelete);
Parameter
Name | Typ | Beschreibung |
---|---|---|
messages | GmailMessage[] | die Nachrichten, die in den Papierkorb verschoben werden sollen |
Return
GmailApp
– der Gmail-Dienst (nützlich für Verkettungen)
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveThreadToArchive(thread)
Verschiebt diesen Thread in das Archiv und erzwingt eine Aktualisierung des Threads.
// Archive the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToArchive(firstThread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | der zu archivierende Thread |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveThreadToInbox(thread)
Verschiebt diesen Thread in den Posteingang und erzwingt eine Aktualisierung des Threads.
// Find a thread not already in your inbox var thread = GmailApp.search("-in:inbox")[0]; // Get the first one GmailApp.moveThreadToInbox(thread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | Die Konversation wird in den Posteingang verschoben. |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveThreadToSpam(thread)
Verschiebt diesen Thread in den Spamordner und erzwingt eine Aktualisierung.
// Tag first thread in inbox as spam var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToSpam(firstThread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | die Unterhaltung in den Spamordner verschoben wird |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveThreadToTrash(thread)
Verschiebt diesen Thread in den Papierkorb und erzwingt eine Aktualisierung.
// Move first thread in inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToTrash(firstThread);
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | den Thread in den Papierkorb verschieben |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveThreadsToArchive(threads)
Verschiebt diese Threads in das Archiv und erzwingt eine Aktualisierung der Threads.
// Move first two threads in your inbox to the archive var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToArchive(firstTwoThreads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | Ein Array von Threads, die archiviert werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveThreadsToInbox(threads)
Verschiebt diese Threads in den Posteingang und erzwingt eine Aktualisierung der Threads.
// Find two threads not already in your inbox var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2); GmailApp.moveThreadsToInbox(firstTwoThreads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | Eine Reihe von Threads, die in den Posteingang verschoben werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveThreadsToSpam(threads)
Diese Threads werden in den Spamordner verschoben und die Threads werden aktualisiert.
// Move first two threads in your inbox to spam var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToSpam(firstTwoThreads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | Eine Reihe von Threads, die in den Spamordner verschoben werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
moveThreadsToTrash(threads)
Verschiebt diese Threads in den Papierkorb und erzwingt eine Aktualisierung.
// Move first two threads in your inbox to trash var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToTrash(firstTwoThreads);
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | Ein Array von Threads, die in den Papierkorb verschoben werden sollen |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
refreshMessage(message)
Lädt die Nachricht und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben)
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; // ...Do something that may take a while here.... GmailApp.refreshMessage(firstMessage); // ...Do more stuff with firstMessage...
Parameter
Name | Typ | Beschreibung |
---|---|---|
message | GmailMessage | die zu aktualisierende Nachricht |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
refreshMessages(messages)
Lädt die Nachrichten und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben)
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 2); // ...Do something that may take a while here.... GmailApp.refreshMessages(coupleOfMessages); // ...Do more stuff with coupleOfMessages...
Parameter
Name | Typ | Beschreibung |
---|---|---|
messages | GmailMessage[] | die zu aktualisierenden Nachrichten |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
refreshThread(thread)
Lädt den Thread und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; // ...Do something that may take a while here.... GmailApp.refreshThread(firstThread); // ... Do more stuff with the thread ...
Parameter
Name | Typ | Beschreibung |
---|---|---|
thread | GmailThread | der zu aktualisierende Thread |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
refreshThreads(threads)
Lädt die Threads und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).
var threads = GmailApp.getInboxThreads(0, 3); // ...Do something that may take a while here.... GmailApp.refreshThreads(threads); // ... Do more stuff with threads ...
Parameter
Name | Typ | Beschreibung |
---|---|---|
threads | GmailThread[] | die zu aktualisierenden Threads |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
search(query)
Suchen Sie in Gmail mit der angegebenen Suchanfrage.
Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Ist die Threadgröße unbekannt und potenziell sehr groß, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.
// Find starred messages with subject IMPORTANT var threads = GmailApp.search('is:starred subject:"IMPORTANT"');
Parameter
Name | Typ | Beschreibung |
---|---|---|
query | String | da Sie sie in Gmail eingeben würden, |
Return
GmailThread[]
: ein Array von Gmail-Threads, die dieser Abfrage entsprechen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
search(query, start, max)
Suchen Sie in Gmail mit der angegebenen Suchanfrage.
// 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. var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);
Parameter
Name | Typ | Beschreibung |
---|---|---|
query | String | da Sie sie in Gmail eingeben würden, |
start | Integer | Index des Startthreads |
max | Integer | die maximale Anzahl der zurückzugebenden Threads |
Return
GmailThread[]
: ein Array von Gmail-Threads, die dieser Abfrage entsprechen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
sendEmail(recipient, subject, body)
Sendet eine E-Mail-Nachricht. Die Größe der E-Mail (einschließlich Header) ist begrenzt.
// The code below will send an email with the current date and time. var 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 von E-Mail-Adressen |
subject | String | Betreff der E-Mail (maximal 250 Zeichen) |
body | String | E-Mail-Text |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
sendEmail(recipient, subject, body, options)
Sendet eine E-Mail-Nachricht mit optionalen Argumenten. Die E-Mail kann nur Text oder HTML-Text enthalten. Die Größe der E-Mail (einschließlich Header, aber ohne Anhänge) ist begrenzt.
// Send an email with a file from Google Drive attached as a PDF. var 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 | In der Betreffzeile (maximal 250 Zeichen) |
body | String | Der E-Mail-Text |
options | Object | Ein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
attachments | BlobSource[] | Ein Array von Dateien, die mit der E-Mail gesendet werden sollen |
bcc | String | eine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc |
cc | String | eine durch Kommas getrennte Liste von E-Mail-Adressen, die in Cc gesetzt werden sollen |
from | String | Die Adresse, von der die E-Mail gesendet werden soll. Diese muss einer der von getAliases() zurückgegebenen Werte sein. |
htmlBody | String | Ist die Richtlinie festgelegt, verwenden Geräte, die HTML rendern können, dieses Argument anstelle des erforderlichen Textarguments. Wenn du Inline-Bilder für deine E-Mail hast, kannst du ein optionales inlineImages -Feld im HTML-Text hinzufügen. |
inlineImages | Object | Ein JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String ) zu Bilddaten (BlobSource ) enthält. Dabei wird davon ausgegangen, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält. |
name | String | den Namen des Absenders der E-Mail (Standard: der Name des Nutzers) |
noReply | Boolean | true , wenn die E-Mail von einer generischen E-Mail-Adresse gesendet werden soll, von der keine Antworten gesendet werden können, um Empfänger davon abzuhalten, auf E-Mails zu antworten. Diese Option ist nur für Google Workspace-Konten und nicht für Gmail-Nutzer möglich. |
replyTo | String | eine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers) |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
setCurrentMessageAccessToken(accessToken)
Legt das aktuelle Zugriffstoken für die Nachricht fest, mit dem das Skript auf die aktuellen GmailMessage
-Attribute zugreifen kann.
Diese Methode ist nur für Google Workspace-Add-on-Projekte erforderlich, die aktuelle Nachrichtenbereiche in Gmail verwenden.
function handleAddonActionEvent(e) { var accessToken = e.messageMetadata.accessToken; var messageId = e.messageMetadata.messageId; GmailApp.setCurrentMessageAccessToken(accessToken); var mailMessage = GmailApp.getMessageById(messageId); // Do something with mailMessage }
Parameter
Name | Typ | Beschreibung |
---|---|---|
accessToken | String | das temporäre Zugriffstoken, das von einem Aktionsereignisobjekt des Gmail-Add-ons abgerufen wurde |
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
starMessage(message)
Diese Nachricht wird mit einem Stern markiert und die Aktualisierung wird erzwungen.
// Stars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.starMessage(message);
Parameter
Name | Typ | Beschreibung |
---|---|---|
message | GmailMessage | die zu markierende Nachricht |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
starMessages(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 var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.starMessages(coupleOfMessages);
Parameter
Name | Typ | Beschreibung |
---|---|---|
messages | GmailMessage[] | ein Array mit zu markierenden Nachrichten |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
unstarMessage(message)
Die Nachricht wird nicht mit einem Stern markiert und sie wird aktualisiert.
// Unstars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.unstarMessage(message);
Parameter
Name | Typ | Beschreibung |
---|---|---|
message | GmailMessage | der Nachricht, deren Markierung Sie aufheben möchten |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/
Weitere Informationen
unstarMessages(messages)
Die Nachrichten werden mit einem Stern markiert und die Nachrichten werden aktualisiert.
// Unstars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.unstarMessages(coupleOfMessages);
Parameter
Name | Typ | Beschreibung |
---|---|---|
messages | GmailMessage[] | Array mit Nachrichten, deren Markierung entfernt werden soll |
Return
GmailApp
– der Gmail-Dienst, der für Verkettungen hilfreich ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://mail.google.com/