Class GmailMessage

GmailMessage

Eine Nachricht im Gmail-Konto eines Nutzers.

Methoden

MethodeRückgabetypKurzbeschreibung
createDraftReply(body)GmailDraftErstellt eine Nachricht als Antwort an den Absender dieser Nachricht unter Verwendung der Antwortadresse.
createDraftReply(body, options)GmailDraftErstellt einen Nachrichtentwurf als Antwort an den Absender dieser Nachricht unter Verwendung der Antwortadresse mit optionalen Argumenten.
createDraftReplyAll(body)GmailDraftErstellt eine Antwortnachricht an den Absender mit der Antwortadresse und allen Empfängern dieser Nachricht.
createDraftReplyAll(body, options)GmailDraftErstellt eine Antwortnachricht an den Absender dieser Nachricht mit der Antwortadresse und allen Empfängern mit optionalen Argumenten.
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 für diese Nachricht ab.
getAttachments(options)GmailAttachment[]Ruft alle Anhänge für diese Nachricht ab.
getBcc()StringRuft die durch Kommas getrennten Empfänger ab, die in der Blindkopie (Bcc) dieser Nachricht enthalten sind.
getBody()StringRuft den HTML-Inhalt des Texts dieser Nachricht ab.
getCc()StringRuft die durch Kommas getrennten Empfänger ab, die in dieser Nachricht in Cc gesetzt wurden.
getDate()DateRuft das Datum und die Uhrzeit dieser Nachricht ab.
getFrom()StringRuft den Absender der Nachricht ab.
getHeader(name)StringRuft den Wert eines RFC 2822-Headers anhand des Header-Namens ab.
getId()StringRuft die ID dieser Nachricht ab.
getPlainBody()StringRuft den Inhalt des Texts dieser Nachricht ohne HTML-Formatierung ab.
getRawContent()StringRuft den Rohinhalt dieser Nachricht ab.
getReplyTo()StringRuft die Antwortadresse dieser Nachricht ab (in der Regel 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 dieser Nachricht ab.
isDraft()BooleanGibt an, ob diese Nachricht ein Entwurf ist.
isInChats()BooleanGibt zurück, 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 Posteingang mit Priorität befindet. Andernfalls wird false zurückgegeben.
isInTrash()BooleanRuft ab, ob sich diese Nachricht im Papierkorb befindet.
isStarred()BooleanGibt an, ob diese Nachricht mit einem Stern markiert ist.
isUnread()BooleanGibt an, 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)GmailMessageAntworten an den Absender dieser Nachricht werden an die Antwortadresse gesendet.
reply(body, options)GmailMessageAntworten an den Absender dieser Nachricht über die Antwortadresse mit optionalen Argumenten.
replyAll(body)GmailMessageAntworten an den Absender über die Antwortadresse und an alle Empfänger dieser Nachricht.
replyAll(body, options)GmailMessageAntworten an den Absender dieser Nachricht über die Antwortadresse und alle Empfänger mit optionalen Argumenten.
star()GmailMessageDie Nachricht wird mit einem Sternchen versehen.
unstar()GmailMessageDie Markierung der Nachricht wird aufgehoben.

Detaillierte Dokumentation

createDraftReply(body)

Erstellt eine Nachricht als Antwort an den Absender dieser Nachricht unter Verwendung der Antwortadresse. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

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

Parameter

NameTypBeschreibung
bodyStringDer Text der E‑Mail.

Rückflug

GmailDraft: Die neu erstellte Entwurfsnachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


createDraftReply(body, options)

Erstellt einen Nachrichtentwurf, in dem auf den Absender dieser Nachricht mit der Antwortadresse geantwortet wird. Optionale Argumente sind möglich.

Die E‑Mail kann sowohl Nur-Text als auch einen HTML-Text enthalten. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 der E‑Mail-Adressen, die in BCC gesetzt werden sollen
ccStringEine durch Kommas getrennte Liste der E‑Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringWenn dieser Parameter festgelegt ist, verwenden Geräte, die HTML rendern können, ihn anstelle des erforderlichen „body“-Arguments. Sie können ein optionales inlineImages-Feld im HTML-Textkörper hinzufügen, wenn Sie Inline-Bilder für Ihre E‑Mail haben.
inlineImagesObjectEin JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (BlobSource) enthält. Dies setzt voraus, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält.
nameStringDer Name des Absenders der E‑Mail (Standard: der Name des Nutzers)
replyToStringEine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E‑Mail mit bis zu 250 Zeichen.

Rückflug

GmailDraft: Die neu erstellte Entwurfsnachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


createDraftReplyAll(body)

Erstellt eine Nachricht als Antwort an den Absender mit der Antwortadresse und allen Empfängern dieser Nachricht. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

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

Parameter

NameTypBeschreibung
bodyStringDer Text der E‑Mail.

Rückflug

GmailDraft: Die neu erstellte Entwurfsnachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


createDraftReplyAll(body, options)

Erstellt eine Antwortnachricht an den Absender dieser Nachricht mit der Antwortadresse und allen Empfängern mit optionalen Argumenten.

Die E‑Mail kann sowohl Nur-Text als auch einen HTML-Text enthalten. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 der E‑Mail-Adressen, die in BCC gesetzt werden sollen
ccStringEine durch Kommas getrennte Liste der E‑Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringWenn dieser Parameter festgelegt ist, verwenden Geräte, die HTML rendern können, ihn anstelle des erforderlichen „body“-Arguments. Sie können ein optionales inlineImages-Feld im HTML-Textkörper hinzufügen, wenn Sie Inline-Bilder für Ihre E‑Mail haben.
inlineImagesObjectEin JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (BlobSource) enthält. Dies setzt voraus, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält.
nameStringDer Name des Absenders der E‑Mail (Standard: der Name des Nutzers)
replyToStringEine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E‑Mail mit bis zu 250 Zeichen.

Rückflug

GmailDraft: Die neu erstellte Entwurfsnachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


forward(recipient)

Leitet diese Nachricht an neue Empfänger weiter. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

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

Parameter

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

Rückflug

GmailMessage: Diese Nachricht ist nützlich für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


forward(recipient, options)

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

Die E‑Mail kann sowohl Nur-Text als auch einen HTML-Text enthalten. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 der E‑Mail-Adressen, die in BCC gesetzt werden sollen
ccStringEine durch Kommas getrennte Liste der E‑Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringWenn dieser Parameter festgelegt ist, verwenden Geräte, die HTML rendern können, ihn anstelle des erforderlichen „body“-Arguments. Sie können ein optionales inlineImages-Feld im HTML-Textkörper hinzufügen, wenn Sie Inline-Bilder für Ihre E‑Mail haben.
inlineImagesObjectEin JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (BlobSource) enthält. Dies setzt voraus, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält.
nameStringDer Name des Absenders der E‑Mail (Standard: der Name des Nutzers)
noReplyBooleantrue, wenn die E‑Mail von einer allgemeinen „Nicht antworten“-E‑Mail-Adresse gesendet werden soll, um Empfänger davon abzuhalten, auf E‑Mails zu antworten. Diese Option ist nur für Google Workspace-Konten verfügbar, nicht für Gmail-Nutzer.
replyToStringEine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E‑Mail mit bis zu 250 Zeichen.

Rückflug

GmailMessage: Diese Nachricht ist nützlich für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getAttachments()

Ruft alle Anhänge für diese Nachricht ab.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getAttachments(options)

Ruft alle Anhänge für diese 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 Inlinebilder enthalten soll (Standard ist true).
includeAttachmentsBooleantrue, wenn das zurückgegebene Array von Blob-Anhängen reguläre (nicht Inline-)Anhänge enthalten soll (Standard ist true).

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getBcc()

Ruft die durch Kommas getrennten Empfänger ab, die in der Blindkopie (Bcc) dieser Nachricht enthalten sind.

Dieses Feld ist für alle empfangenen Nachrichten per Definition leer.

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

Rückflug

String: Die durch Kommas getrennten Empfänger, die in der Blindkopie dieser Nachricht enthalten sind.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getBody()

Ruft den HTML-Inhalt des Texts dieser Nachricht ab.

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

Rückflug

String – Der Inhalt dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getCc()

Ruft die durch Kommas getrennten Empfänger ab, die in dieser Nachricht in Cc gesetzt wurden.

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

Rückflug

String: Die durch Kommas getrennten Empfänger, die in dieser Nachricht in der Cc-Zeile stehen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getDate()

Ruft das Datum und die Uhrzeit dieser Nachricht ab.

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

Rückflug

Date: Das Datum und die Uhrzeit dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getFrom()

Ruft den Absender der Nachricht ab.

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

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getHeader(name)

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const 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 den Doppelpunkt, der ihn vom Wert trennt.

Rückflug

String: Der Wert des Headers oder ein leerer String, wenn der Header in der Nachricht nicht vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getId()

Ruft die ID dieser Nachricht ab.

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

Rückflug

String: Die Nachrichten-ID.


getPlainBody()

Ruft den Inhalt des Texts dieser Nachricht ohne HTML-Formatierung ab. Das ist komplexer als getBody() und dauert länger.

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

Rückflug

String: Der Nur-Text-Inhalt dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getRawContent()

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

Rückflug

String: Der Rohinhalt dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getReplyTo()

Ruft die Antwortadresse dieser Nachricht ab (in der Regel der Absender).

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

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getSubject()

Ruft den Betreff der Nachricht ab.

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

Rückflug

String: Der Betreff dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getThread()

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

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

Rückflug

GmailThread: Der GmailThread, der diese Nachricht enthält.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

getTo()

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

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

Rückflug

String: Die kommagetrennten Empfänger dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


isDraft()

Gibt an, ob diese Nachricht ein Entwurf ist.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

Rückflug

Boolean: Gibt an, ob diese Nachricht ein Entwurf ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

isInChats()

Gibt zurück, ob es sich bei dieser Nachricht um einen Chat handelt.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

Rückflug

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


isInInbox()

Ruft ab, ob sich diese Nachricht im Posteingang befindet.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

isInPriorityInbox()

Gibt true zurück, wenn sich diese Nachricht im Posteingang mit Priorität befindet. Andernfalls wird false zurückgegeben.

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let 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()}`);
}

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

isInTrash()

Ruft ab, ob sich diese Nachricht im Papierkorb befindet.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

Rückflug

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


isStarred()

Gibt an, ob diese Nachricht mit einem Stern markiert ist.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

Rückflug

Boolean: Gibt an, ob diese Nachricht mit einem Stern markiert ist.


isUnread()

Gibt an, ob diese Nachricht ungelesen ist.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

Rückflug

Boolean: Der Status „Ungelesen“ dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

markRead()

Die Nachricht wird als gelesen markiert.

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

Rückflug

GmailMessage: Diese GmailMessage ist nützlich für das Chaining.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markUnread()

Die Nachricht wird als ungelesen markiert.

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

Rückflug

GmailMessage: Diese GmailMessage ist nützlich für das Chaining.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveToTrash()

Die Nachricht wird in den Papierkorb verschoben.

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

Rückflug

GmailMessage: Diese GmailMessage ist nützlich für das Chaining.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


refresh()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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

Rückflug

GmailMessage: Diese Nachricht für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

reply(body)

Antworten an den Absender dieser Nachricht werden an die Antwortadresse gesendet. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

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

Parameter

NameTypBeschreibung
bodyStringDer Text der E‑Mail.

Rückflug

GmailMessage: Diese Nachricht ist nützlich für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


reply(body, options)

Antworten an den Absender dieser Nachricht über die Antwortadresse mit optionalen Argumenten.

Die E‑Mail kann sowohl Nur-Text als auch einen HTML-Text enthalten. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 der E‑Mail-Adressen, die in BCC gesetzt werden sollen
ccStringEine durch Kommas getrennte Liste der E‑Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringWenn dieser Parameter festgelegt ist, verwenden Geräte, die HTML rendern können, ihn anstelle des erforderlichen „body“-Arguments. Sie können ein optionales inlineImages-Feld im HTML-Textkörper hinzufügen, wenn Sie Inline-Bilder für Ihre E‑Mail haben.
inlineImagesObjectEin JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (BlobSource) enthält. Dies setzt voraus, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält.
nameStringDer Name des Absenders der E‑Mail (Standard: der Name des Nutzers)
noReplyBooleantrue, wenn die E‑Mail von einer allgemeinen „Nicht antworten“-E‑Mail-Adresse gesendet werden soll, um Empfänger davon abzuhalten, auf E‑Mails zu antworten. Diese Option ist nur für Google Workspace-Konten verfügbar, nicht für Gmail-Nutzer.
replyToStringEine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E‑Mail mit bis zu 250 Zeichen.

Rückflug

GmailMessage: Diese Nachricht ist nützlich für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


replyAll(body)

Antworten an den Absender über die Antwortadresse und an alle Empfänger dieser Nachricht. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

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

Parameter

NameTypBeschreibung
bodyStringDer Text der E‑Mail.

Rückflug

GmailMessage: Diese Nachricht,die für die Verkettung nützlich ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


replyAll(body, options)

Antworten an den Absender dieser Nachricht über die Antwortadresse und alle Empfänger mit optionalen Argumenten.

Die E‑Mail kann sowohl Nur-Text als auch einen HTML-Text enthalten. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.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 der E‑Mail-Adressen, die in BCC gesetzt werden sollen
ccStringEine durch Kommas getrennte Liste der E‑Mail-Adressen, die in Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von GmailApp.getAliases() zurückgegebenen Werte sein.
htmlBodyStringWenn dieser Parameter festgelegt ist, verwenden Geräte, die HTML rendern können, ihn anstelle des erforderlichen „body“-Arguments. Sie können ein optionales inlineImages-Feld im HTML-Textkörper hinzufügen, wenn Sie Inline-Bilder für Ihre E‑Mail haben.
inlineImagesObjectEin JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu den Bilddaten (BlobSource) enthält. Dies setzt voraus, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthält.
nameStringDer Name des Absenders der E‑Mail (Standard: der Name des Nutzers)
noReplyBooleantrue, wenn die E‑Mail von einer allgemeinen „Nicht antworten“-E‑Mail-Adresse gesendet werden soll, um Empfänger davon abzuhalten, auf E‑Mails zu antworten. Diese Option ist nur für Google Workspace-Konten verfügbar, nicht für Gmail-Nutzer.
replyToStringEine E‑Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E‑Mail-Adresse des Nutzers)
subjectStringEine neue Betreffzeile für die E‑Mail mit bis zu 250 Zeichen.

Rückflug

GmailMessage: Diese Nachricht ist nützlich für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


star()

Die Nachricht wird mit einem Sternchen versehen.

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

Rückflug

GmailMessage: Diese GmailMessage ist nützlich für das Chaining.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


unstar()

Die Markierung der Nachricht wird aufgehoben.

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

Rückflug

GmailMessage: Diese GmailMessage ist nützlich für das Chaining.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen