;}%20.st6{fill:url(%23SVGID_00000021089067129159788970000008246765442136188072_);}%20.st7{fill:url(%23SVGID_00000117639240116366130650000015074833605515028638_);}%20.st8{opacity:0.4;fill:url(%23SVGID_00000101781798616409025840000016567063639337360777_);}%20.st9{opacity:0.4;fill:url(%23SVGID_00000052086836598721292040000002033117744178971046_);}%20.st10{opacity:0.4;fill:url(%23SVGID_00000159460939004760751800000002448009281983951536_);}%20.st11{opacity:0.4;fill:url(%23SVGID_00000013177830667419993080000017721442101626521532_);}%20.st12{opacity:0.4;fill:url(%23SVGID_00000152235521444854938490000006526001119318383285_);}%20.st13{opacity:0.4;fill:url(%23SVGID_00000119823135212293698520000012774889010992664993_);}%20%3c/style%3e%3cg%3e%3cpolygon%20class='st2'%20points='134.78,14.22%20114.31,48.21%20101.33,69.75%20158.22,69.75%20177.97,36.95%20191.67,14.22%20'/%3e%3cpolygon%20class='st3'%20points='227.55,69.75%20186.61,69.75%20101.33,69.75%20129.78,119.02%20158.16,119.02%20228.61,119.02%20256,119.02%20'/%3e%3cpolygon%20class='st3'%20points='136.93,132.47%20116.46,167.93%2073.82,241.78%20130.71,241.78%20144.9,217.2%20180.13,156.18%20193.82,132.46%20'/%3e%3cpolygon%20class='st3'%20points='121.7,131.95%20101.23,96.49%2058.59,22.63%2030.15,71.91%2044.34,96.49%2079.57,157.5%2093.26,181.22%20'/%3e%3cpolygon%20class='st2'%20points='64.81,131.95%2025.15,131.21%200,130.74%2028.44,180.01%2066.73,180.72%2093.26,181.21%20'/%3e%3cpolygon%20class='st2'%20points='165.38,181.74%20184.58,216.46%20196.75,238.47%20225.19,189.2%20206.66,155.69%20193.83,132.46%20'/%3e%3c/g%3e%3c/svg%3e)
Windmill HubSend email with attachments, search, read, label and draft from any Windmill script, flow or app — save attachments to object storage, trigger a flow on new mail, or pause one until someone clicks an approval link in their inbox.
What you can do with Gmail
Complete, deployable projects built around Gmail — the fastest way to get something real running.
Set up in 2 steps
Connect from the Resources page
Open Resources, click Add a resource/API and pick gmail from the OAuth APIs list. Click Connect and sign in with the Google account the mail should be sent from, then name the resource and save it.
Run your first script
Fork the send email script below, or drop the approval step into a flow to have it wait on a reply.
Scripts
Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.
Send Email
List Send-As Aliases
List Labels
Get Send-As Alias
Get Profile
Download Attachment
Delete Label
Create Label
New Email
Search Messages
Modify Labels
Get Thread
Get Message
Create Draft
Suspend/resume a flow by sending approval URL via email
Flows
Multi-step workflows that already wire Gmail to something else.
Trigger flows from Gmail
Gmail is not only a destination. These inbound paths are supported today.
New email (scheduled poll)
The New Email trigger script polls the mailbox and returns the messages matching a search query since its last run. It needs gmail.readonly or gmail.modify on the connection. To run it, open a flow, add a trigger and choose Scheduled Poll, then pick the trigger script and an interval. Windmill puts the script first in the flow with a loop after it, so the steps you add run once per new item. The cursor is saved per flow: two flows polling the same source each get every item, and test runs keep a cursor of their own.
Instant push (Pub/Sub in your own Google Cloud project)
Gmail only pushes to a Pub/Sub topic you own, which is why the trigger above polls. For instant delivery, create a topic in your Google Cloud project, grant [email protected] the Pub/Sub Publisher role on it, call users.watch with the topic name, and attach Windmill's GCP Pub/Sub trigger (a self-hosted Enterprise feature) to a subscription on that topic. Each notification carries only the mailbox address and a historyId, so the handler calls users.history.list to fetch what changed. users.watch expires after 7 days: call it again daily from a schedule.
Resource type
The shape of the credential every script on this page expects.
gmail
View raw schema →| Field | Type | Required | What it is |
|---|---|---|---|
| token | string | Yes |
Questions
What can Windmill do with my mailbox?
Whatever scope you grant when connecting. The default, gmail.send, only lets scripts send mail (attachments, aliases and thread replies included). Searching, reading, downloading attachments, listing send-as aliases, the profile and the new-email trigger need gmail.readonly or gmail.modify; drafts need gmail.compose or gmail.modify; labelling messages needs gmail.modify, and creating or deleting labels needs gmail.labels or gmail.modify. gmail.modify covers every script, send included, but not permanent deletion. Tick the scope in the connect dialog, or reconnect an existing resource to change it.
Can I create the resource by hand instead of connecting?
Nothing stops you — the resource is a single token field. But there is no long-lived Gmail API token: Google's access tokens last about an hour, and only the OAuth flow returns the refresh token that renews them, which is why this page has no CLI lane. For a credential that does not expire, send through the separate smtp resource instead.
There is no Connect button on my instance
Self-hosted instances need a Google OAuth client configured once by an admin before the tile appears.