Stay organized with collections Save and categorize content based on your preferences.
GmailDraftA user-created draft message in a user's Gmail account.
Detailed documentationdeleteDraft()
Deletes this draft message.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder draft.deleteDraft(); draft.getMessage(); // Throws exception.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://mail.google.com/
getId()
Gets the ID of this draft message.
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(), );Return
String
— the draft ID
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://mail.google.com/
getMessage()
Returns a GmailMessage representing this draft.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const message = draft.getMessage(); Logger.log(message.getSubject());Return
GmailMessage
— the message that represents the contents of this draft
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://mail.google.com/
getMessageId()
Returns the ID of the GmailMessage
representing this draft.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const messageId = draft.getMessageId(); Logger.log(messageId === draft.getMessage().getId());Return
String
— the message ID
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://mail.google.com/
send()
Sends this draft email message. The size of the email (including headers) is quota limited.
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 timestampReturn
GmailMessage
— the newly sent message
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://mail.google.com/
update(recipient, subject, body)
Replaces the contents of this draft message. The size of the email (including headers) is quota limited.
// 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()}`, );Parameters Name Type Description
recipient
String
comma separated list of email addresses subject
String
subject of the email (250 characters maximum) body
String
body of the email Return
GmailDraft
— the newly updated draft
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://mail.google.com/
update(recipient, subject, body, options)
Replaces the contents of this draft message using optional arguments. The email can contain plain text or an HTML body. The size of the email (including headers) is quota limited.
// 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', }, );Parameters Name Type Description
recipient
String
comma separated list of email addresses subject
String
subject of the email (250 characters maximum) body
String
body of the email options
Object
a JavaScript object that specifies advanced parameters, as listed below Advanced parameters Name Type Description attachments
BlobSource[]
an array of files to send with the email bcc
String
a comma-separated list of email addresses to BCC cc
String
a comma-separated list of email addresses to CC from
String
the address that the email should be sent from, which must be one of the values returned by GmailApp.getAliases()
htmlBody
String
if set, devices capable of rendering HTML will use it instead of the required body argument; you can add an optional inlineImages
field in HTML body if you have inlined images for your email inlineImages
Object
a JavaScript object containing a mapping from image key (String
) to image data (BlobSource
); this assumes that the htmlBody
parameter is used and contains references to these images in the format <img src="cid:imageKey" />
name
String
the name of the sender of the email (default: the user's name) replyTo
String
an email address to use as the default reply-to address (default: the user's email address) Return
GmailDraft
— the newly updated draft
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://mail.google.com/
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["A `GmailDraft` represents a user-created draft message within a user's Gmail account."],["You can perform actions on drafts such as deleting, getting the ID, retrieving the associated message, sending, and updating draft content."],["The `update()` method allows modification of the draft's recipient, subject, body, and other optional parameters like attachments and sender name."],["All methods require authorization with the `https://mail.google.com/` scope to access and manipulate Gmail drafts."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4