Portal Community
What this node does: The Gmail node provides complete Gmail API coverage across four resources: message, draft, label, and thread. It also ships a dedicated Gmail Trigger for polling-based workflow initiation. All access is authenticated with a stored OAuth2 CredentialId (Guid) — no SMTP configuration is required.

Resources & Operations (26 total)

message 10 Operations

OperationDescription
message/sendSend a new email. Supports HTML or plain text, attachments, CC/BCC, sender name, reply-to address, and optional attribution footer.
message/replyReply to an existing message by its ID. Preserves thread. Supports HTML/plain, CC/BCC, attachments, and reply-to-sender-only mode.
message/getRetrieve a specific message. Returns simplified or full format; optionally downloads attachments.
message/getManySearch and list messages. Supports Gmail query syntax, label filtering, read status, date ranges, sender filter, and attachment download.
message/deletePermanently delete a message. Bypasses trash — irreversible.
message/trashMove a message to the Gmail Trash.
message/untrashRestore a message from Trash back to the inbox.
message/markAsReadRemove the UNREAD label from a message.
message/markAsUnreadRestore the UNREAD label on a message.
message/addLabelApply one or more label IDs to a message.

draft 4 Operations

OperationDescription
draft/createCreate a new draft. Optionally associate it with an existing thread. Supports HTML/plain, CC/BCC, attachments, reply-to, and from-alias.
draft/getRetrieve a draft by ID. Optionally download attachments.
draft/getManyList drafts. Optionally include spam/trash, download attachments.
draft/deletePermanently delete a draft by ID.

label 4 Operations

OperationDescription
label/createCreate a new Gmail label with configurable list and message visibility settings.
label/getRetrieve a label by its ID.
label/getManyList all labels. Optionally cap with a Limit.
label/deletePermanently delete a label by ID.

thread 8 Operations

OperationDescription
thread/getRetrieve a thread and its messages. Supports simplified format and messages-only mode.
thread/getManySearch threads. Same filter set as message/getMany: query, labels, dates, read status, sender.
thread/deletePermanently delete an entire thread and all its messages. Irreversible.
thread/trashMove an entire thread to Trash.
thread/untrashRestore a thread from Trash.
thread/addLabelApply one or more labels to all messages in a thread.
thread/removeLabelRemove one or more labels from all messages in a thread.
thread/replySend 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.

See the Configuration page for the full property reference.

Key Capabilities

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.

OAuth2 scope: The Gmail node requires a Google OAuth2 credential with full mailbox access. Store and rotate credentials carefully. Restrict production workflow access to authorised team members only. The message/delete and thread/delete operations are permanent — they bypass Trash.