Add Label to Email with Gmail API on New Labeled Email from Gmail API

Pipedream makes it easy to connect APIs for Gmail, Gmail and 2,400+ other apps remarkably fast.

Trigger workflow on

New Labeled Email from the Gmail API

Next, do this

Add Label to Email with the Gmail API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Gmail trigger and Gmail action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Labeled Email trigger
1. Configure timer
2. Connect your Gmail account
3. Select a Label
Configure the Add Label to Email action
1. Connect your Gmail account
2. Select a Message
3. Select one or more Labels
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Labeled Email on Gmail

Description:Emit new event when a new email is labeled.

Version:0.0.6

Key:gmail-new-labeled-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-history.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "gmail-new-labeled-email",
  name: "New Labeled Email",
  description: "Emit new event when a new email is labeled.",
  type: "source",
  version: "0.0.6",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    label: {
      propDefinition: [
        gmail,
        "label",
      ],
    },
  },
  methods: {
    ...common.methods,
    getHistoryTypes() {
      return [
        "labelAdded",
        "messageAdded",
      ];
    },
    generateMeta(message) {
      return {
        id: `${message.id}-${this.label}`,
        summary: `A new message with ID: ${message.id} was labeled with "${this.label}"`,
        ts: +message.internalDate,
      };
    },
    filterHistory(history) {
      return history.filter((item) =>
        (item.labelsAdded && item.labelsAdded[0].labelIds.includes(this.label))
        || (item.messagesAdded
          && item.messagesAdded[0].message.labelIds
          && item.messagesAdded[0].message.labelIds.includes(this.label)));
    },
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Gmail	`gmail`	`app`	This component uses the Gmail app.
Label	`label`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Gmail uses OAuth authentication. When you connect your Gmail account, Pipedream will open a popup window where you can sign into Gmail and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Gmail API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Add Label to Email on Gmail

Description:Add label(s) to an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)

Version:0.0.6

Key:gmail-add-label-to-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Action Code#

import gmail from "../../gmail.app.mjs";

export default {
  key: "gmail-add-label-to-email",
  name: "Add Label to Email",
  description: "Add label(s) to an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)",
  version: "0.0.6",
  type: "action",
  props: {
    gmail,
    message: {
      propDefinition: [
        gmail,
        "message",
      ],
    },
    addLabelIds: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
    },
  },
  async run({ $ }) {
    const {
      gmail,
      message,
      addLabelIds = [],
    } = this;

    const response = await gmail.updateLabels({
      message,
      addLabelIds,
    });

    $.export("$summary", `Successfully added ${addLabelIds.length} label(s)`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Gmail	`gmail`	`app`	This component uses the Gmail app.
Message	`message`	`string`	Select a value from the drop down menu.
Labels	`addLabelIds`	`string[]`	Select a value from the drop down menu.

Action Authentication#

Pipedream requests the following authorization scopes when you connect your account:

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

More Ways to Connect Gmail + Gmail#

Other Popular Integrations#

Create Draft with Gmail API on New Labeled Email from Gmail API

Gmail + Gmail

Add Label to Email with Gmail API on New Labeled Email from Gmail API

Pipedream makes it easy to connect APIs for Gmail, Gmail and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular