Delay Workflow with Delay API on New Email Matching Search from Gmail API

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

Trigger workflow on

New Email Matching Search from the Gmail API

Next, do this

Delay Workflow with the Delay 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 Delay action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Email Matching Search trigger
1. Configure timer
2. Connect your Gmail account
3. Optional- Configure Search Query
4. Optional- Select one or more Labels
Configure the Delay Workflow action
1. Connect your Delay account
2. Configure Duration to delay (value)
3. Select a Duration to delay (unit)
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 Email Matching Search on Gmail

Description:Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.

Version:0.0.2

Key:gmail-new-email-matching-search

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-messages.mjs";

export default {
  ...common,
  key: "gmail-new-email-matching-search",
  name: "New Email Matching Search",
  description: "Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getLabels() {
      return this.labels;
    },
    generateMeta(message) {
      const selectedHeader = message.payload.headers.find(({ name }) => name === "Subject");
      const subject = selectedHeader?.value || "No subject";
      return {
        id: message.id,
        summary: `New email: ${subject}`,
        ts: message.internalDate,
      };
    },
  },
};

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.
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.

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#

Delay Workflow on Delay

Description:Delay the execution of your workflow for a specific amount of time (does not count against your compute time).

Version:0.0.1

Key:delay-workflow-delay

View on GitHub

Delay Overview#

The Delay API in Pipedream is a built-in function that allows you to pause a workflow for a specified amount of time. This can be incredibly useful when you need to stagger API calls to avoid rate limits, wait for an external process to complete, or simply introduce a delay between actions in a sequence. With precision up to milliseconds, the Delay API provides a simple yet powerful tool for managing timing in automation workflows.

Action Code#

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

export default {
  name: "Delay Workflow",
  version: "0.0.1",
  key: "delay-workflow-delay",
  type: "action",
  description: "Delay the execution of your workflow for a specific amount of time (does not count against your compute time).",
  props: {
    delay,
    delayDurationValue: {
      propDefinition: [
        delay,
        "delayDurationValue",
      ],
      label: "Duration to delay (value)",
      description: "Specify a value for how long you'd like to delay your workflow.",
    },
    delayDurationUnit: {
      propDefinition: [
        delay,
        "delayDurationUnit",
      ],
      label: "Duration to delay (unit)",
      description: "Specify the time unit for delaying the workflow.",
    },
  },
  async run({ $ }) {
    const milliseconds = this.delay.convertToMilliseconds(
      this.delayDurationUnit,
      this.delayDurationValue,
    );
    const resp = await $.flow.delay(milliseconds);
    $.export(
      "$summary",
      `Successfully configured this workflow to delay for ${this.delayDurationValue} ${this.delayDurationUnit}.`,
    );
    return resp;
  },
};

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
Delay	`delay`	`app`	This component uses the Delay app.
Duration to delay (value)	`delayDurationValue`	`integer`	Specify a value for how long you'd like to delay your workflow.
Duration to delay (unit)	`delayDurationUnit`	`string`	Select a value from the drop down menu:`MillisecondsSecondsMinutesHours`

Action Authentication#

The Delay API does not require authentication.

About Delay#

Delay, pause, suspend, or have the execution of your workflow wait for as little as one millisecond, or as long as one year.

More Ways to Connect Delay + Gmail#

Other Popular Integrations#

Delay Workflow with Delay API on New Attachment Received from Gmail API

Gmail + Delay

Delay Workflow with Delay API on New Email Matching Search from Gmail API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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