Configuration
Complete property reference for all 26 Gmail operations across message, draft, label, and thread resources, plus the Gmail Trigger.
Authentication
| Property | Required | Description |
|---|---|---|
CredentialId |
Required | Guid referencing a Google OAuth2 credential stored in BizFirst Credentials Manager. This credential must have Gmail API access granted via Google's OAuth2 consent flow. Used by all operations and the Gmail Trigger. |
Resource: message (10 operations)
message/send
| Property | Required | Description |
|---|---|---|
SendTo | Required | Recipient email address(es). Single address or comma-separated list. |
Subject | Required | Email subject line. |
Message | Required | Email body content. Interpreted as HTML or plain text based on EmailType. |
EmailType | Optional | Body content type. "html" (default) or "plain". |
SenderName | Optional | Display name shown in the From field. |
ReplyTo | Optional | Reply-To email address override. |
CcList | Optional | CC recipient email addresses. |
BccList | Optional | BCC recipient email addresses. |
AttachmentBinaryFields | Optional | List of binary field references from upstream nodes to attach to the email. |
AppendAttribution | Optional | Boolean. When true, appends a BizFirstAI attribution footer to the message body. |
message/reply
| Property | Required | Description |
|---|---|---|
MessageId | Required | Gmail message ID of the message to reply to. The reply is added to the same thread. |
Message | Required | Reply body content. |
EmailType | Optional | "html" or "plain". |
SenderName | Optional | Display name for the From field. |
CcList | Optional | CC recipients for the reply. |
BccList | Optional | BCC recipients for the reply. |
AttachmentBinaryFields | Optional | Binary field references for attachments. |
ReplyToSenderOnly | Optional | Boolean. When true, the reply is sent only to the original sender, not to all recipients of the original message. |
message/get
| Property | Required | Description |
|---|---|---|
MessageId | Required | Gmail message ID to retrieve. |
Simplified | Optional | Boolean, default true. When true, returns a condensed output object. When false, returns the full raw Gmail API payload. |
DownloadAttachments | Optional | Boolean. When true, fetches attachment data and maps it to output binary fields. |
AttachmentPrefix | Optional | String prefix for attachment binary field names. Default: "attachment_". |
message/getMany
| Property | Required | Description |
|---|---|---|
ReturnAll | Optional | Boolean. When true, paginates through all results. When false, respects Limit. |
Limit | Optional | Maximum number of messages to return. Default: 50. Ignored when ReturnAll is true. |
Simplified | Optional | Boolean. Condensed output when true. |
DownloadAttachments | Optional | Boolean. Downloads attachments for each message. |
AttachmentPrefix | Optional | Binary field prefix. Default: "attachment_". |
LabelIds | Optional | List of Gmail label IDs to filter by. System labels: INBOX, UNREAD, SENT, TRASH, SPAM. |
IncludeSpamTrash | Optional | Boolean. Include messages from Spam and Trash in results. Default: false. |
FilterQ | Optional | Gmail search query string using the same syntax as the Gmail search bar. Examples: is:unread from:invoices@supplier.com, subject:invoice has:attachment newer_than:7d. |
ReadStatus | Optional | Filter by read state. Values: "read", "unread", or leave null for no filter. |
ReceivedAfter | Optional | Date filter — only include messages received after this date. |
ReceivedBefore | Optional | Date filter — only include messages received before this date. |
Sender | Optional | Filter messages by sender email address. |
message/delete
| Property | Required | Description |
|---|---|---|
MessageId | Required | Gmail message ID to permanently delete. This operation bypasses Trash and is irreversible. |
message/trash
| Property | Required | Description |
|---|---|---|
MessageId | Required | Gmail message ID to move to Trash. Message can be restored with message/untrash. |
message/untrash
| Property | Required | Description |
|---|---|---|
MessageId | Required | Gmail message ID to restore from Trash. |
message/markAsRead
| Property | Required | Description |
|---|---|---|
MessageId | Required | Gmail message ID. Removes the UNREAD label from this message. |
message/markAsUnread
| Property | Required | Description |
|---|---|---|
MessageId | Required | Gmail message ID. Re-applies the UNREAD label to this message. |
message/addLabel
| Property | Required | Description |
|---|---|---|
MessageId | Required | Gmail message ID to label. |
LabelIds | Required | List of label IDs to apply. Use system labels (STARRED, IMPORTANT) or custom label IDs obtained from label/getMany. |
Resource: draft (4 operations)
draft/create
| Property | Required | Description |
|---|---|---|
Message | Required | Draft body content. |
ThreadId | Optional | Existing Gmail thread ID. Associates the draft as a reply within that thread. |
FromAlias | Optional | Alternate from address if the account has send-as aliases configured. |
Subject | Optional | Draft subject line. Omit when creating a thread reply (subject is inherited). |
EmailType | Optional | "html" or "plain". |
ReplyTo | Optional | Reply-To address override. |
CcList | Optional | CC recipients. |
BccList | Optional | BCC recipients. |
AttachmentBinaryFields | Optional | Binary field references to attach to the draft. |
draft/get
| Property | Required | Description |
|---|---|---|
DraftId | Required | Gmail draft ID to retrieve. |
DownloadAttachments | Optional | Boolean. Download and expose draft attachments as binary fields. |
AttachmentPrefix | Optional | Binary field name prefix for attachments. |
draft/getMany
| Property | Required | Description |
|---|---|---|
ReturnAll | Optional | Boolean. Return all drafts (paginated) when true. |
Limit | Optional | Maximum number of drafts. Default: 50. |
DownloadAttachments | Optional | Boolean. Download attachments for each draft. |
AttachmentPrefix | Optional | Binary field name prefix. |
IncludeSpamTrash | Optional | Boolean. Include drafts in Spam and Trash folders. |
draft/delete
| Property | Required | Description |
|---|---|---|
DraftId | Required | Gmail draft ID to permanently delete. |
Resource: label (4 operations)
label/create
| Property | Required | Description |
|---|---|---|
Name | Required | Display name for the new label. Must be unique within the account. |
LabelListVisibility | Optional | Whether the label appears in the Gmail label list. "labelShow" (default) or "labelHide". |
MessageListVisibility | Optional | Whether messages with this label are shown in the message list. "show" (default) or "hide". |
label/get
| Property | Required | Description |
|---|---|---|
LabelId | Required | Gmail label ID to retrieve. Returns name, visibility settings, and message/thread counts. |
label/getMany
| Property | Required | Description |
|---|---|---|
Limit | Optional | Maximum number of labels to return. Omit to return all labels (system and custom). |
label/delete
| Property | Required | Description |
|---|---|---|
LabelId | Required | Gmail label ID to permanently delete. Deleting a label does not delete messages that carry it. |
Resource: thread (8 operations)
thread/get
| Property | Required | Description |
|---|---|---|
ThreadId | Required | Gmail thread ID to retrieve. |
Simplified | Optional | Boolean, default true. When true, returns a condensed thread object. |
ReturnOnlyMessages | Optional | Boolean. When true, returns only the messages array from the thread, not thread-level metadata. |
thread/getMany
| Property | Required | Description |
|---|---|---|
ReturnAll | Optional | Boolean. Paginate through all matching threads when true. |
Limit | Optional | Maximum threads to return. Default: 50. |
Simplified | Optional | Boolean. Condensed output per thread. |
LabelIds | Optional | Filter threads by label IDs. |
IncludeSpamTrash | Optional | Boolean. Include threads from Spam and Trash. |
FilterQ | Optional | Gmail query string. Same syntax as message/getMany. |
ReadStatus | Optional | "read", "unread", or null for all. |
ReceivedAfter | Optional | Date lower bound for thread retrieval. |
ReceivedBefore | Optional | Date upper bound for thread retrieval. |
Sender | Optional | Filter threads by sender email address. |
thread/delete
| Property | Required | Description |
|---|---|---|
ThreadId | Required | Gmail thread ID. Permanently deletes the entire thread and all its messages. Irreversible. |
thread/trash
| Property | Required | Description |
|---|---|---|
ThreadId | Required | Gmail thread ID to move to Trash. |
thread/untrash
| Property | Required | Description |
|---|---|---|
ThreadId | Required | Gmail thread ID to restore from Trash. |
thread/addLabel
| Property | Required | Description |
|---|---|---|
ThreadId | Required | Gmail thread ID. |
LabelIds | Required | List of label IDs to apply to all messages in the thread. |
thread/removeLabel
| Property | Required | Description |
|---|---|---|
ThreadId | Required | Gmail thread ID. |
LabelIds | Required | List of label IDs to remove from all messages in the thread. |
thread/reply
| Property | Required | Description |
|---|---|---|
ThreadId | Required | Gmail thread ID to reply within. |
Message | Required | Reply body content. |
MessageId | Optional | Specific message within the thread to reply to. When omitted, the reply targets the latest message in the thread. |
EmailType | Optional | "html" or "plain". |
SenderName | Optional | Display name for the From field. |
CcList | Optional | CC recipients for the reply. |
BccList | Optional | BCC recipients. |
AttachmentBinaryFields | Optional | Binary field references for attachments. |
ReplyToSenderOnly | Optional | Boolean. Reply only to the original sender, not all recipients. |
Gmail Trigger — GmailTriggerExecutorSettingsInfo
The Gmail Trigger polls the mailbox on a schedule and fires one workflow execution per matching new email. It shares the OAuth2 CredentialId mechanism with the Gmail node.
| Property | Required | Description |
|---|---|---|
CredentialId | Required | Guid of the Google OAuth2 credential to use for polling. |
Simplified | Optional | Boolean. When true, output uses a condensed message object. Default varies by trigger config. |
MaxEmailsPerPoll | Optional | Maximum emails to process in a single poll cycle. Default: 10. Limits burst executions when the inbox contains many new messages. |
IncludeSpamTrash | Optional | Boolean. Include emails from Spam and Trash in the poll scope. |
IncludeDrafts | Optional | Boolean. Include draft messages in the poll scope. |
LabelIds | Optional | List of Gmail label IDs to restrict polling to. Leave empty to poll all mail. |
FilterQ | Optional | Gmail query string to filter which emails trigger the workflow. Uses the same syntax as the Gmail search bar. |
ReadStatus | Optional | Filter by read state. Default: "unread" — polls only unread emails. Set to null to include all read states. |
Sender | Optional | Only trigger on emails from a specific sender address. |
DownloadAttachments | Optional | Boolean. Download and expose attachments as binary output fields when the trigger fires. |
AttachmentPrefix | Optional | Binary field name prefix for downloaded attachments. |
MarkAsRead | Optional | Boolean. Automatically marks each processed email as read after the trigger fires, preventing re-triggering on subsequent polls. |
Destructive operations:
message/delete and thread/delete permanently remove data without moving it to Trash. Prefer message/trash or thread/trash in most automation scenarios to allow recovery.
Finding label IDs: Use
label/getMany to retrieve a list of all labels and their IDs for the authenticated account. System label IDs are fixed constants: INBOX, UNREAD, SENT, TRASH, SPAM, STARRED, IMPORTANT, DRAFT.