View as Markdown
Gmail icon

Gmail TRIGGER

New Email Matching Search

Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.
  • Trigger
  • Polling
  • OAuth
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's Gmail account, configure the source, and choose the webhook where your backend receives events.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const deployed = await pd.triggers.deploy({
  id: "gmail-new-email-matching-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gmail: { authProvisionId: "apn_xxxxxxx" },
    timer: { "intervalSeconds": 900 },
    q: "Search Query",
  },
  webhookUrl: "https://example.com/webhooks/gmail",
})

console.log(deployed.id)

MCP exposes on-demand actions. Event sources are deployed through the Connect SDK or API because they continue listening after the initial request.

SCHEMA

Configuration

These inputs define which events the source watches. Dynamic options are loaded from the connected account.

New Email Matching Search configuration
Property Type Description
timer Timer $.interface.timer
Required
q Search Query string
Apply a search filter using Gmail's standard search operators
Optional
labels Labels string[]
Labels are used to categorize messages and threads within the user's mailbox
Optional Dynamic
withTextPayload Return payload as plaintext boolean
Convert the payload response into a single text field. This reduces the size of the payload and makes it easier for LLMs work with.
Required

01

Connect

Your user authorizes Gmail through Pipedream managed auth.

02

Deploy

Your backend deploys this source with that user's own configuration.

03

Webhook delivery

Every event is sent to the HTTP endpoint you choose when you deploy the source — after each poll.

OR

On-demand retrieval

No webhook required. Your app or agent can fetch recent events from the trigger events API.

Registry key
gmail-new-email-matching-search
Version
0.1.7
App
Gmail
Authentication
OAuth
Delivery
Polling source
Output
Events emitted by Gmail.