Gmail

output.gmail Output v0.1.0

Sends Gmail (text and/or HTML, attachments from binary input), searches the mailbox (Gmail query syntax), or fetches one message with decoded headers and body. Leave both bodies blank to send the input payload as pretty-printed JSON. Uses a Google OAuth2 credential's access token.

The Gmail step on the Studio canvas
The Gmail step as it appears on the Studio canvas — input pins on the left, output ports on the right.

Finding it in the library

Search the builder's node library for Gmail (it lives under Output). A single click opens the in-editor docs panel shown here — description, ports, and every property, without leaving the canvas. Double-click (or drag) to add it to the workflow.

Gmail in the node library, with the in-editor docs panel open
The library entry and the in-editor docs panel for Gmail — the same reference this page is generated from.

Wired up in the builder

Gmail in a real, runnable flow — captured live from the Studio editor, exactly as it looks on your canvas. This is the same workflow used for the example input & output below.

Gmail wired into a runnable workflow in the Studio builder
Gmail wired into a runnable flow — input on the left, output on the right.

How it’s configured

The node’s Configure panel as it opens in the builder when you select the step — every setting laid out with real values. Click any field to edit it.

The Gmail node's Configure panel in the Studio builder
The Configure panel for Gmail, showing the settings from the flow above.

Ports

Ports are the node’s contract with its neighbours. In the editor a port label renders bold when wired and italic when optional; ports accept attachment carriers rather than data wires.

DirectionPortLabelWhat flows through it
InputinputInput
OutputoutputResult

How data flows through it

Gmail consumes the content of the incoming envelope — when it is fed directly by a trigger, the trigger’s wrapper is unwrapped at the node boundary so the node sees the actual data, not the metadata shell. Its output becomes the payload for the next node, while the envelope (trace ids, correlation, binary refs) rides along untouched. In the Runs view you always see the whole envelope for both sides of this node.

Expressions in the config

String-typed properties accept {{ }} expressions evaluated against the incoming item at run time — e.g. {{ $json.customer.email }}. On this node that’s accessToken, to, cc, bcc, subject, bodyText, bodyHtml, q, messageId, baseUrl. JSON- and code-typed fields never interpolate — they are passed through literally.

Build it with AI

Every node in this reference is reachable through Flowdrome’s AI Copilot and the MCP tools — say what you want, and the graph surgery happens server-side. Node types resolve fuzzily, so the catalog label (Gmail) works as well as the exact type id (output.gmail).

In the Copilot panel (or any connected AI):

add a gmail node after the trigger

As a step in a create_chain_workflow call:

{"type":"Gmail","config":{}}
Raw MCP call — add this node to a workflow with add_node
curl -s -X POST http://localhost:48170/mcp -H "content-type: application/json" -d '{ "jsonrpc": "2.0", "id": "1", "method": "tools/call", "params": { "name": "add_node", "arguments": { "workflowId": "<id>", "type": "Gmail" } } }'

Example input & output

Captured from a real test run of the workflow above — this is what you see in the run data panel after pressing Test workflow.

Input — what the node received

The Gmail node's input envelope in the run data viewer
The input envelope in the Runs view — Flowdrome always shows the whole envelope, with the payload inside body.

Output — what the node produced

The Gmail node's output envelope in the run data viewer
The output envelope after the step ran.

Property reference

Every setting, with its type and default — the same fields shown configured in the panel above.

PropertyTypeDefaultDescription
Credential
credentialId
credential "" Use a stored credential for this connection — its fields are filled in at run start. Pick "None" to enter the connection details manually.
accepts credential templates: google-oauth2
Access token
accessToken
string "" Google OAuth2 access token — use ${credential.google-oauth2.accessToken}. Empty is allowed here; it must resolve by run time.
Operation
operation
select "send" Send an email, list/search the mailbox, or get one message with decoded headers and body.
getlistsend
To
to
string "" Recipient address(es), comma-separated.
Shown when (operation ?? "send") === "send"
Cc
cc
string "" Carbon-copy address(es), comma-separated.
Shown when (operation ?? "send") === "send"
Bcc
bcc
string "" Blind-carbon-copy address(es), comma-separated.
Shown when (operation ?? "send") === "send"
Subject
subject
string "" Subject line. Non-ASCII text is UTF-8 encoded automatically.
Shown when (operation ?? "send") === "send"
Body (text)
bodyText
string "" Plain-text body. With an HTML body too, the email is sent as multipart/alternative. Both blank = the input payload as pretty-printed JSON.
Shown when (operation ?? "send") === "send"
Body (HTML)
bodyHtml
string "" HTML body.
Shown when (operation ?? "send") === "send"
Attachments field
attachmentsField
field "" Dot-path to one attachment or an array of them on the input — binary blobs, base64 envelopes, or { name, contentType, data } objects. Leave blank for none.
Shown when (operation ?? "send") === "send"
Search query
q
string "" Gmail search syntax, e.g. is:unread newer_than:7d from:boss@example.com. Leave blank for all messages.
Shown when operation === "list"
Label IDs
labelIds
json [] JSON array of label IDs to filter by, e.g. ["INBOX", "UNREAD"].
Shown when operation === "list"
Max results
maxResults
int 50 Messages per page (max 500). Without Return all, this is also the output cap.
Shown when operation === "list"
Return all
returnAll
boolean false Follow the page cursor until every match is returned.
Shown when operation === "list"
Message ID
messageId
string "" The Gmail message ID to fetch (from a list result).
Shown when operation === "get"
Format
format
select "full" full = headers + decoded text/html body; metadata = headers only; minimal = ids and labels only.
fullmetadataminimal
Shown when operation === "get"
Base URL
baseUrl
string "" Gmail API base URL (override for testing; also FLOWDROME_GMAIL_API_BASE). Blank = https://gmail.googleapis.com.
Timeout (ms)
timeoutMs
int 30000 Abort each API request after this many milliseconds.

Related nodes

The rest of the Output group — the same folder you’d scan in the editor’s library.

This page is generated from the node registry by gen-node-docs.mjs on every site build — ports, properties, defaults and visibility rules cannot drift from the code. The screenshots and example data are captured from a live Flowdrome by npm run shots:nodes and npm run gen:examples.