Class GmailDraft

    • GmailDraft represents a user-created draft message in a user's Gmail account.

    • You can perform various actions on a GmailDraft, including deleting, sending, and updating its content.

    • You can retrieve information about a GmailDraft, such as its ID and the underlying GmailMessage it represents.

    • Updating a draft allows you to replace its contents with new recipient, subject, and body information, with options for attachments and HTML body.
    Gmail Draft

    A user-created draft message in a user's Gmail account.

    Methods

    Method Return type Brief description
    delete Draft()
    		void Deletes this draft message.
    get Id()
    		String Gets the ID of this draft message.
    get Message()
    		Gmail Message Returns a GmailMessage representing this draft.
    get Message Id()
    		String Returns the ID of the Gmail Message representing this draft.
    send()
    		Gmail Message Sends this draft email message.
    update(recipient, subject, body)
    		Gmail Draft Replaces the contents of this draft message.
    update(recipient, subject, body, options)
    		Gmail Draft Replaces the contents of this draft message using optional arguments.

    Detailed documentation

    delete Draft()

    Deletes this draft message.

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

    Authorization

    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/

    get Id()

    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

    Authorization

    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/

    get Message()

    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

    Gmail Message — the message that represents the contents of this draft

    Authorization

    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/

    get Message Id()

    Returns the ID of the Gmail Message 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

    Authorization

    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 timestamp

    Return

    Gmail Message — the newly sent message

    Authorization

    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

    Gmail Draft — the newly updated draft

    Authorization

    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/

    See also

    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
    		Blob Source[] 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 Gmail App.getAliases()
    html Body
    		String if set, devices capable of rendering HTML will use it instead of the required body argument; you can add an optional inline Images field in HTML body if you have inlined images for your email
    inline Images
    		Object a JavaScript object containing a mapping from image key ( String ) to image data ( Blob Source ); this assumes that the html Body 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)
    reply To
    		String an email address to use as the default reply-to address (default: the user's email address)

    Return

    Gmail Draft — the newly updated draft

    Authorization

    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/

    See also
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: