Class GmailDraft

GmailDraft

Eine vom Nutzer erstellte Nachricht im Gmail-Konto des Nutzers.

Methoden

MethodeRückgabetypKurzbeschreibung
deleteDraft()voidDamit wird dieser Nachrichtenentwurf gelöscht.
getId()StringRuft die ID dieser Nachrichten-ID ab.
getMessage()GmailMessageGibt ein GmailMessage-Objekt zurück, das diesen Entwurf darstellt.
getMessageId()StringGibt die ID des GmailMessage zurück, das diesen Entwurf darstellt.
send()GmailMessageSendet diese E‑Mail-Nachricht.
update(recipient, subject, body)GmailDraftErsetzt den Inhalt dieser Entwurfsnachricht.
update(recipient, subject, body, options)GmailDraftErsetzt den Inhalt dieses Nachrichtenentwurfs durch optionale Argumente.

Detaillierte Dokumentation

deleteDraft()

Damit wird dieser Nachrichtenentwurf gelöscht. 

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
draft.deleteDraft();
draft.getMessage();  // Throws exception.

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 Nachrichten-ID ab. 

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const draftId = draft.getId();
const draftById = GmailApp.getDraft(draftId);
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

Rückflug

String: die ID des Entwurfs

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/

getMessage()

Gibt ein GmailMessage-Objekt zurück, das diesen Entwurf darstellt. 

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const message = draft.getMessage();
Logger.log(message.getSubject());

Rückflug

GmailMessage: Die Nachricht, die den Inhalt dieses Entwurfs darstellt.

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/

getMessageId()

Gibt die ID des GmailMessage zurück, das diesen Entwurf darstellt. 

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const messageId = draft.getMessageId();
Logger.log(messageId === draft.getMessage().getId());

Rückflug

String: die Nachrichten-ID

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/

send()

Sendet diese E‑Mail-Nachricht. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt. 

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const msg = draft.send();     // Send it
Logger.log(msg.getDate());    // Should be approximately the current timestamp

Rückflug

GmailMessage: die neu gesendete 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/

update(recipient, subject, body)

Ersetzt den Inhalt dieser Entwurfsnachricht. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt. 

// The code below will update a draft email with the current date and time.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const now = new Date();
draft.update(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

Parameter

NameTypBeschreibung
recipientStringDurch Kommas getrennte Liste der E‑Mail-Adressen
subjectStringBetreff der E‑Mail (maximal 250 Zeichen)
bodyStringE‑Mail-Text

Rückflug

GmailDraft – der neu aktualisierte Entwurf

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

update(recipient, subject, body, options)

Ersetzt den Inhalt dieses Nachrichtenentwurfs durch optionale Argumente. Die E-Mail kann Nur-Text oder einen HTML-Text enthalten. Die Größe der E‑Mail (einschließlich Kopfzeilen) ist kontingentbeschränkt. 

// Update a draft email with a file from Google Drive attached as a PDF.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
draft.update(
    'mike@example.com',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

Parameter

NameTypBeschreibung
recipientStringDurch Kommas getrennte Liste der E‑Mail-Adressen
subjectStringBetreff der E‑Mail (maximal 250 Zeichen)
bodyStringE‑Mail-Text
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt (siehe unten)

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 dem HTML-Textkörper ein optionales inlineImages-Feld 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)

Rückflug

GmailDraft – der neu aktualisierte Entwurf

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