Class GmailDraft

GmailEntwurf

Ein von einem Nutzer erstellter Nachrichtenentwurf im Gmail-Konto eines Nutzers.

Methoden

MethodeRückgabetypKurzbeschreibung
deleteDraft()voidDieser Nachrichtenentwurf wird gelöscht.
getId()StringRuft die ID dieser Nachrichtenvorlage ab.
getMessage()GmailMessageGibt eine GmailMessage zurück, die diesen Entwurf darstellt.
getMessageId()StringGibt die ID der GmailMessage zurück, die diesen Entwurf darstellt.
send()GmailMessageSendet diese E-Mail-Vorlage.
update(recipient, subject, body)GmailDraftErsetzt den Inhalt dieser Entwurfsnachricht.
update(recipient, subject, body, options)GmailDraftErsetzt den Inhalt dieser Entwurfsnachricht durch optionale Argumente.

Detaillierte Dokumentation

deleteDraft()

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

  • https://mail.google.com/

getMessage()

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

  • https://mail.google.com/

getMessageId()

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

  • https://mail.google.com/

send()

Sendet diese E-Mail-Vorlage. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

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

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

  • https://mail.google.com/

Weitere Informationen


update(recipient, subject, body, options)

Ersetzt den Inhalt dieser Entwurfsnachricht durch optionale Argumente. Die E-Mail kann Nur-Text oder einen HTML-Textkörper enthalten. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// 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 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 festgelegt, 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)

Rückflug

GmailDraft – der neu aktualisierte Entwurf

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