Class GmailMessage

GmailNachricht

Eine Nachricht im Gmail-Konto eines Nutzers.

Methoden

MethodeRückgabetypKurzbeschreibung
createDraftReply(body)GmailDraftErstellt einen Nachrichtenentwurf, in dem der Absender dieser Nachricht über die Adresse „An“ beantwortet wird.
createDraftReply(body, options)GmailDraftErstellt einen Entwurf einer Antwortnachricht, die an den Absender dieser Nachricht mit der Rücksendeadresse gesendet wird. Optionale Argumente sind zulässig.
createDraftReplyAll(body)GmailDraftErstellt einen Entwurf einer Antwort an den Absender mit der Antwortadresse und allen Empfängern dieser Nachricht.
createDraftReplyAll(body, options)GmailDraftErstellt einen Entwurf einer Antwortnachricht an den Absender dieser Nachricht mit der Rücksendeadresse und allen Empfängern mit optionalen Argumenten.
forward(recipient)GmailMessageDiese Nachricht wird an neue Empfänger weitergeleitet.
forward(recipient, options)GmailMessageDiese Nachricht wird mit optionalen Argumenten an neue Empfänger weitergeleitet.
getAttachments()GmailAttachment[]Ruft alle Anhänge für diese Nachricht ab.
getAttachments(options)GmailAttachment[]Ruft alle Anhänge für diese Nachricht ab.
getBcc()StringDie durch Kommas getrennten Empfänger, die in dieser Nachricht eine Bcc-Adresse haben.
getBody()StringRuft den HTML-Inhalt des Textkörpers dieser Nachricht ab.
getCc()StringDie Empfänger, die in dieser Nachricht auf Kopie gesetzt wurden, werden durch Kommas getrennt.
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 Headernamens ab.
getId()StringRuft die ID dieser Nachricht ab.
getPlainBody()StringRuft den Inhalt des Textkörpers dieser Nachricht ohne HTML-Formatierung ab.
getRawContent()StringRuft den Rohinhalt dieser Nachricht ab.
getReplyTo()StringDie Antwortadresse dieser Nachricht wird abgerufen (normalerweise die des Absenders).
getSubject()StringRuft den Betreff der Nachricht ab.
getThread()GmailThreadRuft den Thread ab, der diese Nachricht enthält.
getTo()StringDie Empfänger dieser Nachricht, getrennt durch Kommas.
isDraft()BooleanGibt an, ob es sich bei dieser Nachricht um einen Entwurf handelt.
isInChats()BooleanGibt an, ob es sich bei dieser Nachricht um einen Chat handelt.
isInInbox()BooleanGibt an, 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()BooleanGibt an, 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()GmailMessageDiese Nachricht und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben.
reply(body)GmailMessageHiermit wird der Absender dieser Nachricht über die Antwortadresse kontaktiert.
reply(body, options)GmailMessageHiermit wird an den Absender dieser Nachricht mit der Antwortadresse geantwortet. Optionale Argumente sind zulässig.
replyAll(body)GmailMessageAntworten an den Absender über die Adresse „An:“ und an alle Empfänger dieser Nachricht.
replyAll(body, options)GmailMessageHiermit antworten Sie dem Absender dieser Nachricht über die Adresse „An“ und alle Empfänger mit optionalen Argumenten.
star()GmailMessageDie Nachricht wird mit einem Stern markiert.
unstar()GmailMessageDie Markierung für die Nachricht wird aufgehoben.

Detaillierte Dokumentation

createDraftReply(body)

Erstellt einen Nachrichtenentwurf, in dem der Absender dieser Nachricht über die Adresse „An“ beantwortet wird. Die Größe der E-Mail (einschließlich Header) ist kontingentiert.

// 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
bodyStringDen Text der E-Mail.

Rückflug

GmailDraft: Die neu erstellte Entwurfsnachricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


createDraftReply(body, options)

Erstellt einen Entwurf einer Antwortnachricht, die an den Absender dieser Nachricht mit der Rücksendeadresse gesendet wird. Optionale Argumente sind zulässig.

Die E-Mail kann sowohl Nur-Text als auch einen HTML-Textkörper enthalten. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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
bodyStringDen Text der E-Mail.
optionsObjectEin JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf 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 dieses Attribut festgelegt ist, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inlineImages-Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben.
inlineImagesObjectein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (String) zu Bilddaten (BlobSource); 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: 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, maximal 250 Zeichen.

Rückflug

GmailDraft: Die neu erstellte Entwurfsnachricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


createDraftReplyAll(body)

Erstellt einen Entwurf einer Antwort an den Absender mit der Antwortadresse und allen Empfängern dieser Nachricht. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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
bodyStringDen Text der E-Mail.

Rückflug

GmailDraft: Die neu erstellte Entwurfsnachricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


createDraftReplyAll(body, options)

Erstellt einen Entwurf einer Antwortnachricht an den Absender dieser Nachricht mit der Rücksendeadresse und allen Empfängern mit optionalen Argumenten.

Die E-Mail kann sowohl Nur-Text als auch einen HTML-Textkörper enthalten. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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
bodyStringDen Text der E-Mail.
optionsObjectEin JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf 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 dieses Attribut festgelegt ist, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inlineImages-Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben.
inlineImagesObjectein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (String) zu Bilddaten (BlobSource); 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: 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, maximal 250 Zeichen.

Rückflug

GmailDraft: Die neu erstellte Entwurfsnachricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


forward(recipient)

Diese Nachricht wird an neue Empfänger weitergeleitet. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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 für die Verkettung nützlich.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


forward(recipient, options)

Diese Nachricht wird mit optionalen Argumenten an neue Empfänger weitergeleitet.

Die E-Mail kann sowohl Nur-Text als auch einen HTML-Textkörper enthalten. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

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 die unten aufgeführten erweiterten Parameter angibt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf 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 dieses Attribut festgelegt ist, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inlineImages-Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben.
inlineImagesObjectein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (String) zu Bilddaten (BlobSource); 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: Name des Nutzers)
noReplyBooleantrue, wenn die E-Mail von einer generischen E-Mail-Adresse ohne Antwortfunktion gesendet werden soll, um Empfänger davon abzuhalten, auf E-Mails zu antworten. Diese Option ist nur für Google Workspace-Konten verfügbar, nicht für Gmail-Nutzer.
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, maximal 250 Zeichen.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 die unten aufgeführten erweiterten Parameter angibt.

Erweiterte Parameter

NameTypBeschreibung
includeInlineImagesBooleantrue, wenn das zurückgegebene Array von Blob-Anhängen Inline-Bilder 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getBcc()

Die durch Kommas getrennten Empfänger, die in dieser Nachricht eine Bcc-Adresse haben.

Dieses Feld ist für alle empfangenen Nachrichten definitionsgemäß 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 dieser Nachricht eine Blindkopie erhalten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getBody()

Ruft den HTML-Inhalt des Textkörpers 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 Textkörper dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getCc()

Die Empfänger, die in dieser Nachricht auf Kopie gesetzt wurden, werden durch Kommas getrennt.

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 auf Kopie gesetzt wurden.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten 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.

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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 Textkörpers dieser Nachricht ohne HTML-Formatierung ab. Das ist komplizierter 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 unformatierte Textkörper dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getRawContent()

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

Rückflug

String: Der Rohinhalt dieser Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getReplyTo()

Die Antwortadresse dieser Nachricht wird abgerufen (normalerweise die des Absenders).

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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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 der Nachricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


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 Gmail-Thread, der diese Nachricht enthält.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getTo()

Die Empfänger dieser Nachricht, getrennt durch Kommas.

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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


isDraft()

Gibt an, ob es sich bei dieser Nachricht um einen Entwurf handelt.

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 es sich bei dieser Nachricht um einen Entwurf handelt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

isInChats()

Gibt an, 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()

Gibt an, 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

isInTrash()

Gibt an, 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen 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, nützlich für die Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


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, nützlich für die Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


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, nützlich für die Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


refresh()

Diese Nachricht und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben.

const 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, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

reply(body)

Hiermit wird der Absender dieser Nachricht über die Antwortadresse kontaktiert. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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
bodyStringDen Text der E-Mail.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


reply(body, options)

Hiermit wird an den Absender dieser Nachricht mit der Antwortadresse geantwortet. Optionale Argumente sind zulässig.

Die E-Mail kann sowohl Nur-Text als auch einen HTML-Textkörper enthalten. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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
bodyStringDen Text der E-Mail.
optionsObjectEin JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf 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 dieses Attribut festgelegt ist, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inlineImages-Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben.
inlineImagesObjectein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (String) zu Bilddaten (BlobSource); 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: Name des Nutzers)
noReplyBooleantrue, wenn die E-Mail von einer generischen E-Mail-Adresse ohne Antwortfunktion gesendet werden soll, um Empfänger davon abzuhalten, auf E-Mails zu antworten. Diese Option ist nur für Google Workspace-Konten verfügbar, nicht für Gmail-Nutzer.
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, maximal 250 Zeichen.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


replyAll(body)

Antworten an den Absender über die Adresse „An:“ und an alle Empfänger dieser Nachricht. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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
bodyStringDen Text der E-Mail.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


replyAll(body, options)

Hiermit antworten Sie dem Absender dieser Nachricht über die Adresse „An“ und alle Empfänger mit optionalen Argumenten.

Die E-Mail kann sowohl Nur-Text als auch einen HTML-Textkörper enthalten. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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
bodyStringDen Text der E-Mail.
optionsObjectEin JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt.

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf 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 dieses Attribut festgelegt ist, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inlineImages-Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben.
inlineImagesObjectein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (String) zu Bilddaten (BlobSource); 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: Name des Nutzers)
noReplyBooleantrue, wenn die E-Mail von einer generischen E-Mail-Adresse ohne Antwortfunktion gesendet werden soll, um Empfänger davon abzuhalten, auf E-Mails zu antworten. Diese Option ist nur für Google Workspace-Konten verfügbar, nicht für Gmail-Nutzer.
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, maximal 250 Zeichen.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


star()

Die Nachricht wird mit einem Stern markiert.

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, nützlich für die Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


unstar()

Die Markierung für die 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, nützlich für die Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen