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.

Ports

Direction	Port	Label
Input	`input`	Payload
Output	`output`	Result

Properties

Property	Type	Default	Description
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. `sendlistget`
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`	`string`	`""`	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 NINER_GMAIL_API_BASE). Blank = https://gmail.googleapis.com.
Timeout (ms) `timeoutMs`	`int`	`30000`	Abort each API request after this many milliseconds.

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.