# New Attachment Received — Gmail

> Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.

- Key: `gmail-new-attachment-received`
- Type: Trigger (Polling)
- Version: 0.2.7
- App: Gmail (`gmail`) — https://pipedream.com/apps/gmail.md
- This page (HTML): https://pipedream.com/apps/gmail/triggers/new-attachment-received
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/gmail/sources/new-attachment-received/new-attachment-received.mjs

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `timer` | `$.interface.timer` | Yes | Timer |
| `q` | `string` | No | Apply a search filter using Gmail's standard search operators |
| `labels` | `string[]` | No | Labels are used to categorize messages and threads within the user's mailbox Options are loaded from the connected account. |
| `withTextPayload` | `boolean` | Yes | Convert the payload response into a single text field. This reduces the size of the payload and makes it easier for LLMs work with. |
| `includeLink` | `boolean` | No | Upload attachment to your File Stash and emit temporary download link to the file. See the docs to learn more about working with files in Pipedream. |
| `dir` | `dir` | No | Dir |

## Returns

Events emitted by Gmail.

## Run it

**TypeScript**

```ts
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-attachment-received",
  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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/triggers/deploy \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "gmail-new-attachment-received",
    "webhook_url": "https://example.com/webhooks/gmail",
    "configured_props": {
      "gmail": { "authProvisionId": "apn_xxxxxxx" },
      "timer": { "intervalSeconds": 900 },
      "q": "Search Query"
    }
  }'
```

**MCP**

MCP servers expose Gmail actions as on-demand tools.

New Attachment Received is an event source, so your application deploys it with the Connect SDK or API and then either receives each event at a webhook URL or retrieves events on demand with the trigger events API.

## Event delivery

Every event is sent to the HTTP endpoint you choose when you deploy the source. Or: no webhook required — your app or agent can fetch recent events from the [trigger events API](https://pipedream.com/docs/connect/api-reference/list-trigger-events.md) instead.

---

- App: https://pipedream.com/apps/gmail.md · All apps: https://pipedream.com/apps