Class GmailMessage

GmailMessage

Eine Nachricht im Gmail-Konto eines Nutzers.

Methoden

MethodeRückgabetypKurzbeschreibung
createDraftReply(body)GmailDraftErstellt einen Nachrichtenentwurf als Antwort an den Absender dieser Nachricht unter Verwendung der Antwortadresse.
createDraftReply(body, options)GmailDraftErstellt einen Nachrichtenentwurf, der dem Absender dieser Nachricht unter Verwendung der Antwortadresse mit optionalen Argumenten antwortet.
createDraftReplyAll(body)GmailDraftErstellt einen Nachrichtenentwurf, der dem Absender mit der Antwortadresse und allen Empfängern der Nachricht antwortet.
createDraftReplyAll(body, options)GmailDraftErstellt einen Nachrichtenentwurf, der dem Absender dieser Nachricht mit der Antwortadresse und allen Empfängern mit optionalen Argumenten antwortet.
forward(recipient)GmailMessageLeitet diese Nachricht an neue Empfänger weiter.
forward(recipient, options)GmailMessageLeitet diese Nachricht mit optionalen Argumenten an neue Empfänger weiter.
getAttachments()GmailAttachment[]Ruft alle Anhänge der Nachricht ab.
getAttachments(options)GmailAttachment[]Ruft alle Anhänge der Nachricht ab.
getBcc()StringRuft die durch Kommas getrennten Empfänger in Bcc für diese Nachricht ab.
getBody()StringRuft den HTML-Inhalt des Nachrichtentexts ab.
getCc()StringRuft die durch Kommas getrennten Empfänger in Cc der Nachricht ab.
getDate()DateRuft das Datum und die Uhrzeit der Nachricht ab.
getFrom()StringRuft den Absender der Nachricht ab.
getHeader(name)StringRuft den Wert eines RFC 2822-Headers anhand des Headernamens ab.
getId()StringRuft die ID der Nachricht ab.
getPlainBody()StringRuft den Inhalt des Nachrichtentexts ohne HTML-Formatierung ab.
getRawContent()StringRuft den Rohinhalt der Nachricht ab.
getReplyTo()StringRuft die Antwortadresse dieser Nachricht ab (normalerweise der Absender).
getSubject()StringRuft den Betreff der Nachricht ab.
getThread()GmailThreadRuft den Thread ab, der diese Nachricht enthält.
getTo()StringRuft die durch Kommas getrennten Empfänger der Nachricht ab.
isDraft()BooleanRuft ab, ob es sich bei dieser Nachricht um einen Entwurf handelt.
isInChats()BooleanRuft ab, ob es sich bei dieser Nachricht um einen Chat handelt.
isInInbox()BooleanRuft ab, ob sich diese Nachricht im Posteingang befindet.
isInPriorityInbox()BooleanGibt true zurück, wenn sich diese Nachricht im sortierten Posteingang befindet. Andernfalls wird false zurückgegeben.
isInTrash()BooleanRuft ab, ob sich die Nachricht im Papierkorb befindet.
isStarred()BooleanRuft ab, ob diese Nachricht markiert ist.
isUnread()BooleanRuft ab, ob diese Nachricht ungelesen ist.
markRead()GmailMessageDie Nachricht wird als gelesen markiert.
markUnread()GmailMessageDie Nachricht wird als ungelesen markiert.
moveToTrash()GmailMessageDie Nachricht wird in den Papierkorb verschoben.
refresh()GmailMessageLä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)GmailMessageDer Absender der Nachricht erhält eine Antwort über die Antwortadresse.
reply(body, options)GmailMessageDer Absender der Nachricht erhält eine Antwort über die Antwortadresse mit optionalen Argumenten.
replyAll(body)GmailMessageDem Absender wird über die Antwortadresse und alle Empfänger dieser Nachricht geantwortet.
replyAll(body, options)GmailMessageDem Absender dieser Nachricht wird die Antwortadresse und alle Empfänger mit optionalen Argumenten verwendet.
star()GmailMessageDie Nachricht wird markiert.
unstar()GmailMessageHebt die Markierung der Nachricht auf.

Detaillierte Dokumentation

createDraftReply(body)

Erstellt einen Nachrichtenentwurf als Antwort an den Absender dieser Nachricht unter Verwendung der Antwortadresse. Die Größe der E-Mail (einschließlich Header) ist auf das Kontingent begrenzt.

// Create a draft reply to the original message with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("Got your message");

Parameter

NameTypBeschreibung
bodyStringDer Text der E-Mail.

Return

GmailDraft: Der neu erstellte Nachrichtenentwurf.

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


createDraftReply(body, options)

Erstellt einen Nachrichtenentwurf, der dem Absender dieser Nachricht unter Verwendung der Antwortadresse mit optionalen Argumenten antwortet.

Die E-Mail kann sowohl Text als auch HTML-Text enthalten. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

Parameter

NameTypBeschreibung
bodyStringDer Text der E-Mail.
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]Ein Array von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc
ccStringeine durch Kommas getrennte Liste von E-Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Diese muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringwird dieses Argument von Geräten, die HTML rendern können, anstelle des erforderlichen Textarguments verwendet. Wenn Sie Bilder für die E-Mail eingefügt haben, können Sie ein optionales inlineImages-Feld im HTML-Text hinzufügen.
inlineImagesObjectEin 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.
nameStringden Namen des Absenders der E-Mail (Standard: der Name des Nutzers)
replyToStringeine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E-Mail, die maximal 250 Zeichen umfasst.

Return

GmailDraft: Der neu erstellte Nachrichtenentwurf.

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


createDraftReplyAll(body)

Erstellt einen Nachrichtenentwurf, der dem Absender mit der Antwortadresse und allen Empfängern der Nachricht antwortet. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

// Create a draft response to all recipients (except those bcc'd) with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

Parameter

NameTypBeschreibung
bodyStringDer Text der E-Mail.

Return

GmailDraft: Der neu erstellte Nachrichtenentwurf.

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


createDraftReplyAll(body, options)

Erstellt einen Nachrichtenentwurf, der dem Absender dieser Nachricht mit der Antwortadresse und allen Empfängern mit optionalen Argumenten antwortet.

Die E-Mail kann sowohl Text als auch HTML-Text enthalten. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

// Create a draft response to all recipients (except those bcc'd) using an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

Parameter

NameTypBeschreibung
bodyStringDer Text der E-Mail.
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]Ein Array von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc
ccStringeine durch Kommas getrennte Liste von E-Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Diese muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringwird dieses Argument von Geräten, die HTML rendern können, anstelle des erforderlichen Textarguments verwendet. Wenn Sie Bilder für die E-Mail eingefügt haben, können Sie ein optionales inlineImages-Feld im HTML-Text hinzufügen.
inlineImagesObjectEin 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.
nameStringden Namen des Absenders der E-Mail (Standard: der Name des Nutzers)
replyToStringeine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E-Mail, die maximal 250 Zeichen umfasst.

Return

GmailDraft: Der neu erstellte Nachrichtenentwurf.

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


forward(recipient)

Leitet diese Nachricht an neue Empfänger weiter. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

// Forward first message of first inbox thread to recipient1 & recipient2, both @example.com
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com");

Parameter

NameTypBeschreibung
recipientStringEine durch Kommas getrennte Liste von E-Mail-Adressen.

Return

GmailMessage: Diese Nachricht ist für Verkettungen nützlich.

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


forward(recipient, options)

Leitet diese Nachricht mit optionalen Argumenten an neue Empfänger weiter.

Die E-Mail kann sowohl reinen Text als auch HTML-Text enthalten. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com", {
  cc: "myboss@example.com",
  bcc: "mybosses-boss@example.com,vp@example.com"
});

Parameter

NameTypBeschreibung
recipientStringEine durch Kommas getrennte Liste von E-Mail-Adressen.
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]Ein Array von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc
ccStringeine durch Kommas getrennte Liste von E-Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Diese muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringwird dieses Argument von Geräten, die HTML rendern können, anstelle des erforderlichen Textarguments verwendet. Wenn Sie Bilder für die E-Mail eingefügt haben, können Sie ein optionales inlineImages-Feld im HTML-Text hinzufügen.
inlineImagesObjectEin 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.
nameStringden Namen des Absenders der E-Mail (Standard: der Name des Nutzers)
noReplyBooleantrue, 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.
replyToStringeine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E-Mail, die maximal 250 Zeichen umfasst.

Return

GmailMessage: Diese Nachricht ist für Verkettungen nützlich.

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


getAttachments()

Ruft alle Anhänge der Nachricht ab.

Return

GmailAttachment[]: Ein Array von Blob-Anhängen für diese Nachricht.

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/

getAttachments(options)

Ruft alle Anhänge der Nachricht ab.

Parameter

NameTypBeschreibung
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt.

Erweiterte Parameter

NameTypBeschreibung
includeInlineImagesBooleantrue, wenn das zurückgegebene Array von Blob-Anhängen Inline-Bilder enthalten soll (Standardwert ist true).
includeAttachmentsBooleantrue, wenn das zurückgegebene Array von Blob-Anhängen reguläre (Nicht-Inline-) Anhänge enthalten soll (Standardeinstellung ist true).

Return

GmailAttachment[]: Ein Array von Blob-Anhängen für diese Nachricht.

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/

getBcc()

Ruft die durch Kommas getrennten Empfänger in Bcc für diese Nachricht ab.

Dieses Feld ist per Definition bei allen empfangenen Nachrichten leer.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBcc()); // Log bcc'd addresses

Return

String: Die durch Kommas getrennten Empfänger in Bcc der Nachricht.

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


getBody()

Ruft den HTML-Inhalt des Nachrichtentexts ab.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBody()); // Log contents of the body

Return

String: Der Textinhalt der Nachricht.

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


getCc()

Ruft die durch Kommas getrennten Empfänger in Cc der Nachricht ab.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getCc()); // Log cc'd addresses

Return

String: die durch Kommas getrennten Empfänger in der Nachricht auf Cc.

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


getDate()

Ruft das Datum und die Uhrzeit der Nachricht ab.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getDate()); // Log date and time of the message

Return

Date: Datum und Uhrzeit dieser Nachricht.

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/

getFrom()

Ruft den Absender der Nachricht ab.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getFrom()); // Log from address of the message

Return

String: Die E-Mail-Adresse des Absenders der Nachricht.

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


getHeader(name)

Ruft den Wert eines RFC 2822-Headers anhand des Headernamens ab.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox.
var message = thread.getMessages()[0];         // Get the first message.
Logger.log(message.getHeader("Message-ID"));   // Logs the Message-ID RFC 2822 header.

Parameter

NameTypBeschreibung
nameStringDer Name des RFC-Headers, ohne dass er durch einen Doppelpunkt vom Wert getrennt ist.

Return

String: Der Wert des Headers oder ein leerer String, wenn der Header nicht in der Nachricht vorhanden 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/

getId()

Ruft die ID der Nachricht ab.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
var id = message.getId();
var messageById = GmailApp.getMessageById(id);
Logger.log(message.getSubject() == messageById.getMessage()); // Always logs true

Return

String: Die Nachrichten-ID.


getPlainBody()

Ruft den Inhalt des Nachrichtentexts ohne HTML-Formatierung ab. Dies ist komplexer als getBody() und dauert länger.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getPlainBody()); // Log contents of the body

Return

String: Der reine Textinhalt der Nachricht.

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


getRawContent()

Ruft den Rohinhalt der Nachricht ab. Dies entspricht der Option „Original anzeigen“ in der Gmail-Benutzeroberfläche.

Return

String: Der Rohinhalt dieser Nachricht.

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/

getReplyTo()

Ruft die Antwortadresse dieser Nachricht ab (normalerweise der Absender).

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getReplyTo()); // Logs reply-to address

Return

String: Die E-Mail-Adresse für Antworten.

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


getSubject()

Ruft den Betreff der Nachricht ab.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getSubject()); // Log subject line

Return

String: Der Betreff der Nachricht.

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


getThread()

Ruft den Thread ab, der diese Nachricht enthält.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getThread().getFirstMessageSubject() ==
           thread.getFirstMessageSubject()); // Always logs true

Return

GmailThread: Der GmailThread, der diese Nachricht 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/

getTo()

Ruft die durch Kommas getrennten Empfänger der Nachricht ab.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getTo()); // Log the recipient of message

Return

String: Die durch Kommas getrennten Empfänger der Nachricht.

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


isDraft()

Ruft ab, ob es sich bei dieser Nachricht um einen Entwurf handelt.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

Return

Boolean: gibt an, ob es sich bei dieser Nachricht um einen Entwurf handelt.

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/

isInChats()

Ruft ab, ob es sich bei dieser Nachricht um einen Chat handelt.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

Return

Boolean: gibt an, ob es sich bei dieser Nachricht um einen Chat handelt.


isInInbox()

Ruft ab, ob sich diese Nachricht im Posteingang befindet.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

Return

Boolean: Gibt an, ob sich diese Nachricht im Posteingang befindet.

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/

isInPriorityInbox()

Gibt true zurück, wenn sich diese Nachricht im sortierten Posteingang befindet. Andernfalls wird false zurückgegeben.

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log("is in priority inbox? " + messages[i].isInPriorityInbox());
}

Return

Boolean: Gibt an, ob sich diese Nachricht im sortierten Eingang befindet.

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/

isInTrash()

Ruft ab, ob sich die Nachricht im Papierkorb befindet.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

Return

Boolean: Gibt an, ob sich die Nachricht im Papierkorb befindet.


isStarred()

Ruft ab, ob diese Nachricht markiert ist.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

Return

Boolean: gibt an, ob diese Nachricht markiert ist.


isUnread()

Ruft ab, ob diese Nachricht ungelesen ist.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

Return

Boolean: Der Status dieser Nachricht als ungelesen.

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/

markRead()

Die Nachricht wird als gelesen markiert.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markRead(); // Mark as read

Return

GmailMessage: Diese GmailMessage wird für Verkettungen verwendet.

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


markUnread()

Die Nachricht wird als ungelesen markiert.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markUnread(); // Mark as unread

Return

GmailMessage: Diese GmailMessage wird für Verkettungen verwendet.

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


moveToTrash()

Die Nachricht wird in den Papierkorb verschoben.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.moveToTrash(); // Move message to trash

Return

GmailMessage: Diese GmailMessage wird für Verkettungen verwendet.

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


refresh()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
// .. Do bunch of stuff here
message.refresh(); // Make sure it's up to date
// Do more stuff to message

Return

GmailMessage: Diese Nachricht zur Verkettung.

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/

reply(body)

Der Absender der Nachricht erhält eine Antwort über die Antwortadresse. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

// Respond to author of message with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("Got your message");

Parameter

NameTypBeschreibung
bodyStringDer Text der E-Mail.

Return

GmailMessage: Diese Nachricht ist für Verkettungen nützlich.

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


reply(body, options)

Der Absender der Nachricht erhält eine Antwort über die Antwortadresse mit optionalen Argumenten.

Die E-Mail kann sowohl reinen Text als auch HTML-Text enthalten. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

Parameter

NameTypBeschreibung
bodyStringDer Text der E-Mail.
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]Ein Array von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc
ccStringeine durch Kommas getrennte Liste von E-Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Diese muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringwird dieses Argument von Geräten, die HTML rendern können, anstelle des erforderlichen Textarguments verwendet. Wenn Sie Bilder für die E-Mail eingefügt haben, können Sie ein optionales inlineImages-Feld im HTML-Text hinzufügen.
inlineImagesObjectEin 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.
nameStringden Namen des Absenders der E-Mail (Standard: der Name des Nutzers)
noReplyBooleantrue, 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.
replyToStringeine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E-Mail, die maximal 250 Zeichen umfasst.

Return

GmailMessage: Diese Nachricht ist für Verkettungen nützlich.

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


replyAll(body)

Dem Absender wird über die Antwortadresse und alle Empfänger dieser Nachricht geantwortet. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

// Respond to all recipients (except bcc'd) of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

Parameter

NameTypBeschreibung
bodyStringDer Text der E-Mail.

Return

GmailMessage: Diese Nachricht ist 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


replyAll(body, options)

Dem Absender dieser Nachricht wird die Antwortadresse und alle Empfänger mit optionalen Argumenten verwendet.

Die E-Mail kann sowohl reinen Text als auch HTML-Text enthalten. Die Größe der E-Mail (einschließlich Header) ist begrenzt.

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
messageThread.replyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

Parameter

NameTypBeschreibung
bodyStringDer Text der E-Mail.
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]Ein Array von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc
ccStringeine durch Kommas getrennte Liste von E-Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Diese muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringwird dieses Argument von Geräten, die HTML rendern können, anstelle des erforderlichen Textarguments verwendet. Wenn Sie Bilder für die E-Mail eingefügt haben, können Sie ein optionales inlineImages-Feld im HTML-Text hinzufügen.
inlineImagesObjectEin 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.
nameStringden Namen des Absenders der E-Mail (Standard: der Name des Nutzers)
noReplyBooleantrue, 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.
replyToStringeine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E-Mail, die maximal 250 Zeichen umfasst.

Return

GmailMessage: Diese Nachricht ist für Verkettungen nützlich.

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


star()

Die Nachricht wird markiert.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.star(); // Star the message

Return

GmailMessage: Diese GmailMessage wird für Verkettungen verwendet.

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


unstar()

Hebt die Markierung der Nachricht auf.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.unstar(); // Unstar the message

Return

GmailMessage: Diese GmailMessage wird für Verkettungen verwendet.

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