Gmail icon

CONNECT APP

Build with Gmail

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

Communication

  • OAuth

MCP

Give your agent Gmail tools

Every Gmail action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Gmail account for each tool call — you store no tokens.

// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": "{project_id}",
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "gmail",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Add Label to Email:
const result = await mcp.callTool({
  name: "gmail-add-label-to-email",
  arguments: {
    message: "Message",
    addLabelIds: ["Labels"],
  },
})

API PROXY

Call the Gmail API directly

For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Gmail API with the connected user's credentials attached. You store no tokens and write no refresh logic.

const resp = await pd.proxy.get({
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  accountId: "apn_xxxxxxx",
  url: "https://www.googleapis.com/oauth2/v1/userinfo",
})

// Any allowed Gmail endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.

SDK

Run Gmail actions from your backend

Connect a user's Gmail account once, then run Add Label to Email on their behalf from your own code — TypeScript, Python, or plain HTTP.

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 result = await pd.actions.run({
  id: "gmail-add-label-to-email",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gmail: { authProvisionId: "apn_xxxxxxx" },
    message: "Message",
    addLabelIds: ["Labels"],
  },
})

TOOLS

Gmail actions

On-demand operations your product or agent can configure and run on behalf of a connected user.

MULTI-APP

Use Gmail with other popular apps

Most products don't stop at one integration. Pair Gmail with the other apps your users rely on, and ship use cases that span both.

Google Calendar icon Google Calendar With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next. Google Drive icon Google Drive Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere. Google Sheets icon Google Sheets Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device. Notion icon Notion Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team. Google Docs icon Google Docs Use Google Docs to create, edit and collaborate on online documents. GitHub icon GitHub Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world. HubSpot icon HubSpot HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business. Linear icon Linear Linear helps streamline software projects, sprints, tasks, and bug tracking. It's built for high-performance teams. YouTube Data icon YouTube Data With the YouTube Data API, you can add a variety of YouTube features to your application. Use the API to upload videos, manage playlists and subscriptions, update channel settings, and more. Stripe icon Stripe Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes. Airtable icon Airtable Airtable is a low-code platform to build next-gen apps. Move beyond rigid tools, operationalize your critical data, and reimagine workflows with AI. Google Ads icon Google Ads Reach customers wherever they are. Show up at the right time and place across the vast Google Ads ecosystem.

REFERENCE

App details

Reference metadata for the Gmail connector in the Pipedream registry.

App slug
gmail
Authentication
OAuth
Categories
Communication
Actions
21
Triggers
5
API proxy
Available

OAuth scopes

These are the scopes Pipedream's managed Gmail OAuth client requests when one of your users connects an account. Supply your own OAuth client to request a different set.

  • https://www.googleapis.com/auth/gmail.labels
  • https://www.googleapis.com/auth/gmail.send
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.compose
  • https://www.googleapis.com/auth/gmail.settings.basic