Find Email with Gmail (Developer App) API

Pipedream makes it easy to connect APIs for Gmail (Developer App) and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Find Email with the Gmail (Developer App) API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Create a workflow to Find Email with the Gmail (Developer App) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Find Email action
1. Connect your Gmail (Developer App) account
2. Optional- Configure Search Query
3. Optional- Select one or more Labels
4. Optional- Configure Include Spam and Trash?
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Find Email with Gmail (Developer App) API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Gmail (Developer App)

Try it

Find Email with Gmail (Developer App) API on New Message in Channel from Discord Bot API

Discord Bot + Gmail (Developer App)

Try it

Find Email with Gmail (Developer App) API on New Submission from Typeform API

Typeform + Gmail (Developer App)

Try it

Find Email with Gmail (Developer App) API on Custom Events from Zoom API

Zoom + Gmail (Developer App)

Try it

Find Email with Gmail (Developer App) API on New Submission (Instant) from Jotform API

Jotform + Gmail (Developer App)

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Find Email on Gmail (Developer App)

Description:Find an email using Google's Search Engine. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list)

Version:0.0.9

Key:gmail_custom_oauth-find-email

View on GitHub

Code#

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

export default {
  key: "gmail_custom_oauth-find-email",
  name: "Find Email",
  description: "Find an email using Google's Search Engine. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list)",
  version: "0.0.9",
  type: "action",
  props: {
    gmail,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      description: "Only return messages with labels that match all of the specified labels.",
      optional: true,
    },
    includeSpamTrash: {
      type: "boolean",
      label: "Include Spam and Trash?",
      description: "Include messages from `SPAM` and `TRASH` in the results. Defaults to `false`.",
      optional: true,
      default: false,
    },
  },
  async run({ $ }) {
    const messageIds = [];
    let pageToken;

    do {
      const {
        messages = [],
        nextPageToken,
      } = await this.gmail.listMessages({
        q: this.q,
        labelIds: this.labels,
        includeSpamTrash: this.includeSpamTrash,
        pageToken,
      });
      messageIds.push(...messages.map(({ id }) => id));
      pageToken = nextPageToken;
    } while (pageToken);

    const messages = await this.gmail.getMessages(messageIds);

    const suffix = messages.length === 1
      ? ""
      : "s";
    $.export("$summary", `Successfully found ${messages.length} message${suffix}`);
    return messages;
  },
};

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
Gmail (Developer App)	`gmail`	`app`	This component uses the Gmail (Developer App) app.
Search Query	`q`	`string`	Apply a search filter using Gmail's standard search operators
Labels	`labels`	`string[]`	Select a value from the drop down menu.
Include Spam and Trash?	`includeSpamTrash`	`boolean`	Include messages from `SPAM` and `TRASH` in the results. Defaults to `false`.

Authentication#

Gmail (Developer App) uses OAuth authentication. When you connect your Gmail (Developer App) account, Pipedream will open a popup window where you can sign into Gmail (Developer App) 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 (Developer App) API.

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

do not use

Try it

New Email Received from the Gmail (Developer App) API

Emit new event when an email is received. This source is capped at 100 max new messages per run.

Try it

New Labeled Email from the Gmail (Developer App) API

Emit new event when a new email is labeled.

Try it

New Sent Email from the Gmail (Developer App) API

Emit new event for each new email sent. (Maximum of 300 events emited per execution)

Try it

Actions#

Add Label to Email with the Gmail (Developer App) API

Add a label to an email message. See the docs

Try it

Create Draft with the Gmail (Developer App) API

Create a draft from your Google Workspace email account

Try it

Download Attachement with the Gmail (Developer App) API

Download an attachment by attachmentId to the /tmp directory. See the docs

Try it

Send Email with the Gmail (Developer App) API

Send an email from your Google Workspace email account

Try it

Update Signature for Email in Organization with the Gmail (Developer App) API

Update the signature for a specific email address in an organization. A Google Cloud service account with delegated domain-wide authority is required for this action. See docs here

Try it