Use the Gmail API to Send Emails with Attachments

This example shows how you can easily send email messages with file attachment using the Gmail API. The attachments can be stored in Google Drive and you need to specify the file IDs that are to included in the outgoing messages.

We begin by creating a MIME message that complies with RFC 2822 standard and call the Gmail API to sends the specified message to the recipients in the To, Cc, and Bcc headers. We use the /upload URI with the messages/send method for uploading the files with the message and the uploadType is set to media for uploading the files without any metadata.

The code is written in Google Apps Script but Google also offers Gmail API Client libraries for PHP, Python, JavaScript and NodeJS. If you wish to include images, upload them to a site like imgur and include them in the email’s HTML body using img tags.

// Written by Amit Agarwal
// Web: ctrlq.org
// Email: amit@labnol.org

function sendEmailWithAttachments() {
  var attachments = ['File_ID_1', 'File_ID_2'];

  var message = {
    to: {
      name: 'Google Scripts',
      email: 'amit@labnol.org',
    },
    from: {
      name: 'Amit Agarwal',
      email: 'amit@labnol.org',
    },
    body: {
      text: "Mr hänn is schon lang nümme g'she.",
      html: "Mr hänn is schon <b>lang nümme</b> g'she.",
    },
    subject: 'ctrlq, tech à la carte',
    files: getAttachments_(attachments),
  };

  // Compose Gmail message and send immediately
  callGmailAPI_(message);
}

function callGmailAPI_(message) {
  var payload = createMimeMessage_(message);

  var response = UrlFetchApp.fetch(
    'https://www.googleapis.com/upload/gmail/v1/users/me/messages/send?uploadType=media',
    {
      method: 'POST',
      headers: {
        Authorization: 'Bearer ' + ScriptApp.getOAuthToken(),
        'Content-Type': 'message/rfc822',
      },
      muteHttpExceptions: true,
      payload: payload,
    }
  );

  Logger.log(response.getResponseCode());
  Logger.log(response.getContentText());
}

// UTF-8 characters in names and subject
function encode_(subject) {
  var enc_subject = Utilities.base64Encode(subject, Utilities.Charset.UTF_8);
  return '=?utf-8?B?' + enc_subject + '?=';
}

// Insert file attachments from Google Drive
function getAttachments_(ids) {
  var att = [];
  for (var i in ids) {
    var file = DriveApp.getFileById(ids[i]);
    att.push({
      mimeType: file.getMimeType(),
      fileName: file.getName(),
      bytes: Utilities.base64Encode(file.getBlob().getBytes()),
    });
  }
  return att;
}

// Create a MIME message that complies with RFC 2822
function createMimeMessage_(msg) {
  var nl = '\n';
  var boundary = '__ctrlq_dot_org__';

  var mimeBody = [
    'MIME-Version: 1.0',
    'To: ' + encode_(msg.to.name) + '<' + msg.to.email + '>',
    'From: ' + encode_(msg.from.name) + '<' + msg.from.email + '>',
    'Subject: ' + encode_(msg.subject), // takes care of accented characters

    'Content-Type: multipart/alternative; boundary=' + boundary + nl,
    '--' + boundary,

    'Content-Type: text/plain; charset=UTF-8',
    'Content-Transfer-Encoding: base64' + nl,
    Utilities.base64Encode(msg.body.text, Utilities.Charset.UTF_8) + nl,
    '--' + boundary,

    'Content-Type: text/html; charset=UTF-8',
    'Content-Transfer-Encoding: base64' + nl,
    Utilities.base64Encode(msg.body.html, Utilities.Charset.UTF_8) + nl,
  ];

  for (var i = 0; i < msg.files.length; i++) {
    var attachment = [
      '--' + boundary,
      'Content-Type: ' + msg.files[i].mimeType + '; name="' + msg.files[i].fileName + '"',
      'Content-Disposition: attachment; filename="' + msg.files[i].fileName + '"',
      'Content-Transfer-Encoding: base64' + nl,
      msg.files[i].bytes,
    ];

    mimeBody.push(attachment.join(nl));
  }

  mimeBody.push('--' + boundary + '--');

  return mimeBody.join(nl);
}
Amit Agarwal

Amit Agarwal

Google Developer Expert, Google Cloud Champion

Amit Agarwal is a Google Developer Expert in Google Workspace and Google Apps Script. He holds an engineering degree in Computer Science (I.I.T.) and is the first professional blogger in India.

Amit has developed several popular Google add-ons including Mail Merge for Gmail and Document Studio. Read more on Lifehacker and YourStory

0

Awards & Titles

Digital Inspiration has won several awards since it's launch in 2004.

Google Developer Expert

Google Developer Expert

Google awarded us the Google Developer Expert award recogizing our work in Google Workspace.

ProductHunt Golden Kitty

ProductHunt Golden Kitty

Our Gmail tool won the Lifehack of the Year award at ProductHunt Golden Kitty Awards in 2017.

Microsoft MVP Alumni

Microsoft MVP Alumni

Microsoft awarded us the Most Valuable Professional (MVP) title for 5 years in a row.

Google Cloud Champion

Google Cloud Champion

Google awarded us the Champion Innovator title recognizing our technical skill and expertise.

Email Newsletter

Sign up for our email newsletter to stay up to date.

We will never send any spam emails. Promise.