Gmail Service

Gmail

Mit diesem Dienst können Sie E‑Mails senden, E‑Mail-Entwürfe erstellen, Labels verwalten, Nachrichten und Unterhaltungen markieren und verschiedene andere Aufgaben zur Verwaltung von Gmail-Konten ausführen. Siehe auch Mail Service, ein einfacherer Dienst, der nur das Senden von E-Mails ermöglicht.

Klassen

Name	Kurzbeschreibung
GmailApp	Bietet Zugriff auf Gmail-Konversationen, ‑Nachrichten und ‑Labels.
GmailAttachment	Ein Anhang aus Gmail.
GmailDraft	Ein vom Nutzer erstellter Nachrichtenentwurf im Gmail-Konto des Nutzers.
GmailLabel	Ein vom Nutzer erstelltes Label im Gmail-Konto des Nutzers.
GmailMessage	Eine Nachricht im Gmail-Konto eines Nutzers.
GmailThread	Ein E‑Mail-Verlauf im Gmail-Konto eines Nutzers.

GmailApp

Methoden

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

GmailAttachment

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
copyBlob()	Blob	Gibt eine Kopie dieses Blobs zurück.
getAs(contentType)	Blob	Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getBytes()	Byte[]	Ruft die in diesem Blob gespeicherten Daten ab.
getContentType()	String	Ruft den Inhaltstyp der Byte in diesem Blob ab.
getDataAsString()	String	Ruft die Daten dieses Blobs als String mit UTF-8-Codierung ab.
getDataAsString(charset)	String	Ruft die Daten dieses Blobs als String mit der angegebenen Codierung ab.
getHash()	String	Ruft den SHA1-Inhaltshash für diesen Anhang ab.
getName()	String	Ruft den Namen dieses Blobs ab.
getSize()	Integer	Ruft die Größe dieses Anhangs ab.
isGoogleType()	Boolean	Gibt zurück, ob dieser Blob eine Google Workspace-Datei (Sheets, Docs usw.) ist.
setBytes(data)	Blob	Legt die in diesem Blob gespeicherten Daten fest.
setContentType(contentType)	Blob	Legt den Inhaltstyp der Byte in diesem Blob fest.
setContentTypeFromExtension()	Blob	Legt den Inhaltstyp der Bytes in diesem Blob basierend auf der Dateiendung fest.
setDataFromString(string)	Blob	Legt die Daten dieses Blobs aus einem String mit UTF-8-Codierung fest.
setDataFromString(string, charset)	Blob	Legt die Daten dieses Blobs aus einem String mit der angegebenen Codierung fest.
setName(name)	Blob	Legt den Namen dieses Blobs fest.

GmailDraft

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
deleteDraft()	void	Damit wird dieser Nachrichtenentwurf gelöscht.
getId()	String	Ruft die ID dieser Nachrichten-ID ab.
getMessage()	GmailMessage	Gibt ein GmailMessage-Objekt zurück, das diesen Entwurf darstellt.
getMessageId()	String	Gibt die ID des GmailMessage zurück, das diesen Entwurf darstellt.
send()	GmailMessage	Sendet diese E‑Mail-Nachricht als Entwurf.
update(recipient, subject, body)	GmailDraft	Ersetzt den Inhalt dieser Entwurfsnachricht.
update(recipient, subject, body, options)	GmailDraft	Ersetzt den Inhalt dieses Nachrichtenentwurfs durch optionale Argumente.

GmailLabel

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
addToThread(thread)	GmailLabel	Fügt dem angegebenen Thread dieses Label hinzu und erzwingt eine Aktualisierung des Threads (GmailThread.refresh()).
addToThreads(threads)	GmailLabel	Fügt den angegebenen Threads dieses Label hinzu und erzwingt eine Aktualisierung der Threads.
deleteLabel()	void	Damit wird dieses Label gelöscht.
getId()	String	Ruft die ID dieses Labels ab.
getName()	String	Ruft den Namen dieses Labels ab.
getThreads()	GmailThread[]	Ruft die Threads ab, die mit diesem Label gekennzeichnet sind.
getThreads(start, max)	GmailThread[]	Ruft einen Bereich von Threads ab, die mit diesem Label gekennzeichnet sind.
getUnreadCount()	Integer	Gibt die Anzahl der ungelesenen Threads zurück, die mit diesem Label getaggt sind.
removeFromThread(thread)	GmailLabel	Entfernt dieses Label aus der angegebenen Konversation und erzwingt eine Aktualisierung der Konversation.
removeFromThreads(threads)	GmailLabel	Entfernt dieses Label aus den angegebenen Konversationen und erzwingt eine Aktualisierung der Konversationen.

GmailMessage

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
createDraftReply(body)	GmailDraft	Erstellt eine Nachricht als Antwort an den Absender dieser Nachricht unter Verwendung der Antwortadresse.
createDraftReply(body, options)	GmailDraft	Erstellt einen Nachrichtentwurf, in dem auf den Absender dieser Nachricht mit der Antwortadresse geantwortet wird. Optionale Argumente sind möglich.
createDraftReplyAll(body)	GmailDraft	Erstellt eine Nachricht, die auf den Absender antwortet. Dabei werden die Antwortadresse und alle Empfänger dieser Nachricht verwendet.
createDraftReplyAll(body, options)	GmailDraft	Erstellt eine Antwortnachricht an den Absender dieser Nachricht mit der Antwortadresse und allen Empfängern, mit optionalen Argumenten.
forward(recipient)	GmailMessage	Leitet diese Nachricht an neue Empfänger weiter.
forward(recipient, options)	GmailMessage	Leitet diese Nachricht mit optionalen Argumenten an neue Empfänger weiter.
getAttachments()	GmailAttachment[]	Ruft alle Anhänge für diese Nachricht ab.
getAttachments(options)	GmailAttachment[]	Ruft alle Anhänge für diese Nachricht ab.
getBcc()	String	Ruft die durch Kommas getrennten Empfänger ab, die in der Blindkopie (Bcc) dieser Nachricht enthalten sind.
getBody()	String	Ruft den HTML-Inhalt des Texts dieser Nachricht ab.
getCc()	String	Ruft die durch Kommas getrennten Empfänger ab, die in dieser Nachricht in Cc gesetzt wurden.
getDate()	Date	Ruft das Datum und die Uhrzeit dieser Nachricht ab.
getFrom()	String	Ruft den Absender der Nachricht ab.
getHeader(name)	String	Ruft den Wert eines RFC 2822-Headers anhand des Headernamens ab.
getId()	String	Ruft die ID dieser Nachricht ab.
getPlainBody()	String	Ruft den Inhalt des Texts dieser Nachricht ohne HTML-Formatierung ab.
getRawContent()	String	Ruft den Rohinhalt dieser Nachricht ab.
getReplyTo()	String	Ruft die Antwortadresse dieser Nachricht ab (in der Regel der Absender).
getSubject()	String	Ruft den Betreff der Nachricht ab.
getThread()	GmailThread	Ruft den Thread ab, der diese Nachricht enthält.
getTo()	String	Ruft die durch Kommas getrennten Empfänger dieser Nachricht ab.
isDraft()	Boolean	Gibt an, ob diese Nachricht ein Entwurf ist.
isInChats()	Boolean	Gibt zurück, ob es sich bei dieser Nachricht um einen Chat handelt.
isInInbox()	Boolean	Ruft ab, ob sich diese Nachricht im Posteingang befindet.
isInPriorityInbox()	Boolean	Gibt true zurück, wenn sich diese Nachricht im Posteingang mit Priorität befindet. Andernfalls wird false zurückgegeben.
isInTrash()	Boolean	Ruft ab, ob sich diese Nachricht im Papierkorb befindet.
isStarred()	Boolean	Gibt an, ob diese Nachricht mit einem Stern markiert ist.
isUnread()	Boolean	Gibt an, ob diese Nachricht ungelesen ist.
markRead()	GmailMessage	Die Nachricht wird als gelesen markiert.
markUnread()	GmailMessage	Die Nachricht wird als ungelesen markiert.
moveToTrash()	GmailMessage	Die Nachricht wird in den Papierkorb verschoben.
refresh()	GmailMessage	Lädt diese Nachricht und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).
reply(body)	GmailMessage	Antworten an den Absender dieser Nachricht werden an die Antwortadresse gesendet.
reply(body, options)	GmailMessage	Antworten an den Absender dieser Nachricht über die Antwortadresse mit optionalen Argumenten.
replyAll(body)	GmailMessage	Antworten an den Absender über die Antwortadresse und an alle Empfänger dieser Nachricht.
replyAll(body, options)	GmailMessage	Antworten an den Absender dieser Nachricht über die Antwortadresse und alle Empfänger mit optionalen Argumenten.
star()	GmailMessage	Die Nachricht wird mit einem Stern versehen.
unstar()	GmailMessage	Die Markierung der Nachricht wird aufgehoben.

GmailThread

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
addLabel(label)	GmailThread	Fügt dem Thread dieses Label hinzu.
createDraftReply(body)	GmailDraft	Erstellt eine Nachricht als Antwort an den Absender der letzten Nachricht in diesem Thread unter Verwendung der Antwortadresse.
createDraftReply(body, options)	GmailDraft	Erstellt eine Nachricht als Antwort an den Absender der letzten Nachricht in diesem Thread mit der Antwortadresse und optionalen Argumenten.
createDraftReplyAll(body)	GmailDraft	Erstellt einen Nachrichtenentwurf als Antwort auf den Absender der letzten Nachricht in diesem Thread. Dabei werden die Antwortadresse und alle Empfänger dieser Nachricht verwendet.
createDraftReplyAll(body, options)	GmailDraft	Erstellt eine Nachricht als Antwort auf den Absender der letzten Nachricht in diesem Thread. Dabei werden die Antwortadresse und alle Empfänger verwendet. Optionale Argumente sind möglich.
getFirstMessageSubject()	String	Ruft den Betreff der ersten Nachricht im Thread ab.
getId()	String	Gibt die ID dieses Threads zurück.
getLabels()	GmailLabel[]	Gibt die vom Nutzer erstellten Labels für diesen Thread zurück.
getLastMessageDate()	Date	Ruft das Datum der letzten Nachricht in diesem Thread ab.
getMessageCount()	Integer	Gibt die Anzahl der Nachrichten im Thread zurück.
getMessages()	GmailMessage[]	Ruft die Nachrichten in diesem Thread ab.
getPermalink()	String	Ruft einen Permalink für diesen Thread ab.
hasStarredMessages()	Boolean	Gibt zurück, ob der Thread markierte Nachrichten enthält.
isImportant()	Boolean	Gibt zurück, ob der Thread als wichtig markiert ist.
isInChats()	Boolean	Gibt zurück, ob der Thread als Chat gekennzeichnet ist.
isInInbox()	Boolean	Gibt zurück, ob sich der Thread im Posteingang befindet.
isInPriorityInbox()	Boolean	Gibt „true“ zurück, wenn sich dieser Thread im Posteingang mit Priorität befindet, andernfalls „false“.
isInSpam()	Boolean	Gibt zurück, ob die Unterhaltung als Spam markiert ist.
isInTrash()	Boolean	Gibt zurück, ob sich der Thread im Papierkorb befindet.
isUnread()	Boolean	Gibt zurück, ob der Thread ungelesene Nachrichten enthält.
markImportant()	GmailThread	Markiert diesen Thread als wichtig.
markRead()	GmailThread	Dieser Thread wird als gelesen markiert.
markUnimportant()	GmailThread	Markiert diesen Thread als unwichtig.
markUnread()	GmailThread	Markiert diesen Thread als ungelesen.
moveToArchive()	GmailThread	Verschiebt diesen Thread ins Archiv.
moveToInbox()	GmailThread	Verschiebt diesen Thread in den Posteingang.
moveToSpam()	GmailThread	Verschiebt diesen Thread in den Spamordner.
moveToTrash()	GmailThread	Dadurch wird dieser Thread in den Papierkorb verschoben.
refresh()	GmailThread	Lädt diesen Thread und den zugehörigen Status aus Gmail neu (nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben).
removeLabel(label)	GmailThread	Entfernt dieses Label aus der Konversation.
reply(body)	GmailThread	Antworte dem Absender der letzten Nachricht in diesem Thread über die replyTo-Adresse.
reply(body, options)	GmailThread	Antworte dem Absender der letzten Nachricht in diesem Thread über die replyTo-Adresse mit optionalen Argumenten.
replyAll(body)	GmailThread	Antworten Sie dem Absender (über die „replyTo“-Adresse) und allen Empfängern der letzten Nachricht in diesem Thread.
replyAll(body, options)	GmailThread	Antworte dem Absender (mit der replyTo-Adresse) und allen Empfängern der letzten Nachricht in diesem Thread mit optionalen Argumenten.