Create Gmail Labels with the Gmail API

C
Published in: Google Apps Script - Gmail

You can create labels or folders in Gmail programmatically with the Gmail API. The GmailApp service of Google Apps Script includes the GmailApp.createLabel() method to quickly create new labels but one downside is that this method doesn’t return the internal id of the Gmail Label.

The Gmail Label Id is required if you wish to apply that label to multiple Gmail threads in one go. Thus we are using the advanced Gmail service available inside Google Scripts to create Gmail Labels.

const createGmailLabel = labelName => {
  const { labels = [] } = Gmail.Users.Labels.list('me');
  for (let i = 0; i < labels.length; i += 1) {
    const { name, id } = labels[i];
    if (name === labelName) {
      return id;
    }
  }
  const { id: newLabelId } = Gmail.Users.Labels.create(
    {
      name: labelName,
      labelListVisibility: 'labelShow',
      messageListVisibility: 'show'
    },
    'me'
  );
  return newLabelId;
};

If you are to apply this Gmail label to an array of Gmail messages, use the batchModify method available inside Gmail API.

const applyGmailLabel = (messageIds, labelName) => {
  const labelId = createGmailLabel(labelName);
  Gmail.Users.Messages.batchModify(
    {
      addLabelIds: [labelId],
      ids: messageIds
    },
    'me'
  );
};

These examples are written with ES6 and Apps Script.

📮  Subscribe to our Email Newsletter for Google tips and tutorials!
Published in: Google Apps Script - Gmail

Looking for something? Find here!

Meet the Author

Web Geek, Google Developer Expert
A
Amit Agarwal

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. He is the developer of Mail Merge for Gmail and Document Studio. Read more on Lifehacker and YourStory

Get in touch

Google Add-ons

Do more with your Gmail and GSuite account
G

We build bespoke solutions that use the capabilities and the features of Google Workspace for automating business processes and driving work productivity.

  1. Mail Merge with Attachments
    Send personalized email to your Google Contact with a Google Sheet and Gmail
  2. Save Emails and Attachments
    Download email messages and file attachments from Gmail to your Google Drive
  3. Google Forms Email Notifications
    Send email notifications to multiple people when a new Google Form is submitted
  4. Document Studio
    Create beautiful pixel perfect documents merging data from Google Sheets and Google Forms
  5. Creator Studio for Google Slides
    Turn your Google Slides presentations into animated GIFs and videos for uploading to YouTube