Gmail
Full Gmail API integration — send emails, manage messages, drafts, labels, and threads, with a built-in polling trigger. Authenticated via OAuth2 credential.
CredentialId (Guid) — no SMTP configuration is required.
Resources & Operations (26 total)
message 10 Operations
| Operation | Description |
|---|---|
message/send | Send a new email. Supports HTML or plain text, attachments, CC/BCC, sender name, reply-to address, and optional attribution footer. |
message/reply | Reply to an existing message by its ID. Preserves thread. Supports HTML/plain, CC/BCC, attachments, and reply-to-sender-only mode. |
message/get | Retrieve a specific message. Returns simplified or full format; optionally downloads attachments. |
message/getMany | Search and list messages. Supports Gmail query syntax, label filtering, read status, date ranges, sender filter, and attachment download. |
message/delete | Permanently delete a message. Bypasses trash — irreversible. |
message/trash | Move a message to the Gmail Trash. |
message/untrash | Restore a message from Trash back to the inbox. |
message/markAsRead | Remove the UNREAD label from a message. |
message/markAsUnread | Restore the UNREAD label on a message. |
message/addLabel | Apply one or more label IDs to a message. |
draft 4 Operations
| Operation | Description |
|---|---|
draft/create | Create a new draft. Optionally associate it with an existing thread. Supports HTML/plain, CC/BCC, attachments, reply-to, and from-alias. |
draft/get | Retrieve a draft by ID. Optionally download attachments. |
draft/getMany | List drafts. Optionally include spam/trash, download attachments. |
draft/delete | Permanently delete a draft by ID. |
label 4 Operations
| Operation | Description |
|---|---|
label/create | Create a new Gmail label with configurable list and message visibility settings. |
label/get | Retrieve a label by its ID. |
label/getMany | List all labels. Optionally cap with a Limit. |
label/delete | Permanently delete a label by ID. |
thread 8 Operations
| Operation | Description |
|---|---|
thread/get | Retrieve a thread and its messages. Supports simplified format and messages-only mode. |
thread/getMany | Search threads. Same filter set as message/getMany: query, labels, dates, read status, sender. |
thread/delete | Permanently delete an entire thread and all its messages. Irreversible. |
thread/trash | Move an entire thread to Trash. |
thread/untrash | Restore a thread from Trash. |
thread/addLabel | Apply one or more labels to all messages in a thread. |
thread/removeLabel | Remove one or more labels from all messages in a thread. |
thread/reply | Send a reply within a thread. Optionally target a specific message in the thread; supports reply-to-sender-only. |
Gmail Trigger (Polling)
The Gmail Trigger polls your Gmail mailbox on a configurable schedule and fires the workflow for each new matching email. It is configured via GmailTriggerExecutorSettingsInfo and shares the same CredentialId OAuth2 mechanism.
- Filters by label IDs, Gmail query string, read status, sender, and spam/trash inclusion
- Optionally downloads attachments inline with a configurable prefix
- Configurable
MaxEmailsPerPoll(default 10) limits burst size per execution MarkAsReadflag automatically marks processed emails after firing- Optionally includes drafts (
IncludeDrafts) in the poll scope
See the Configuration page for the full property reference.
Key Capabilities
- OAuth2 authentication via stored
CredentialId(Guid) — no SMTP credentials needed - Full Gmail search query support (
FilterQ) — same syntax as the Gmail search bar - Attachment handling: download, binary field mapping, prefix-based naming for downstream access
- Thread-aware sending and replying — maintain conversation context across operations
- Complete label lifecycle: create, list, apply, remove, delete
- Simplified output mode reduces payload size for message/thread operations
- ReturnAll pagination support for getMany operations
In This Guide
Configuration
Complete property reference for all 26 operations across message, draft, label, and thread resources, plus the Gmail Trigger.
Input & Output
Output schemas for all resources, error codes, and how to reference message and thread IDs in downstream nodes.
Examples
Five real-world workflow examples: send with attachment, search and process unread emails, save a draft, label management, and thread reply.
message/delete and thread/delete operations are permanent — they bypass Trash.