V2NodesGmail Sender
Gmail Sender
V2

Gmail Sender

Gmail is an email service used to send, receive, organize, and search messages by using labels, threads, and mailbox rules.

The Flowgear Gmail Sender Node sends one or more email messages through the Gmail API by using the shared Microsoft Email-style request shape, which makes it useful when you need to automate outbound email delivery without redesigning existing Workflow payloads.

Revision History

0.1.1.0 - Added sanitized sender input echoes to mutation responses.
0.1.0.0 - Published after the completed V2 overhaul.
0.0.0.11 - Aligned the V2 connector contract and public help article.
0.0.0.7 - Initial release.

Connection

This Connection stores the Gmail OAuth client registration and mailbox tokens used by the sender and listener Nodes.

Property Type Description
Client Id String OAuth client identifier issued for the Gmail app registration.
Client Secret Masked OAuth client secret issued for the Gmail app registration.
Access Token Masked OAuth access token used for Gmail API calls.
Refresh Token Masked OAuth refresh token used to renew the access token when needed.
Scopes String Space-delimited Gmail OAuth scopes requested during authorization. The default value is https://www.googleapis.com/auth/gmail.modify.

Setup Notes

  • Enable the Gmail API for the target Google Cloud project and create an OAuth client.
  • Add the Flowgear OAuth redirect URI shown by the Connection designer to the OAuth client's allowed redirect URI list.
  • Create a Gmail Connection in Flowgear, enter Client Id and Client Secret, then connect the mailbox account.
  • The Node expects a usable Access Token or Refresh Token. If neither is present, runtime execution fails fast.
  • The default scope https://www.googleapis.com/auth/gmail.modify is sufficient for the supported sender and listener operations.
  • Connection test performs a lightweight Gmail profile request.

Methods

The Node exposes one method for outbound email delivery.

SendEmail

Sends one or more Gmail messages and returns one response row per Email item.

Parameter Type Description
Connection Connection Gmail OAuth Connection used to authenticate the send request.
Email Array One or more email request items. Each item must include ToRecipients, Subject, and Body. Optional properties are CcRecipients, BccRecipients, HtmlBody, and Attachments.
Return Type Description
Response Array One sender response row per Email item. Each row includes Gmail identifiers plus the Flowgear object for default mutation metadata.

Email child properties

Property Type Description
ToRecipients String Required. One or more recipient email addresses. Separate multiple addresses with commas, semicolons, or line breaks.
CcRecipients String Optional. One or more CC recipient email addresses. Separate multiple addresses with commas, semicolons, or line breaks.
BccRecipients String Optional. One or more BCC recipient email addresses. Separate multiple addresses with commas, semicolons, or line breaks.
Subject String Required. Email subject line.
Body String Required. Email body content.
HtmlBody Boolean Optional. Set to true when Body contains HTML content.
Attachments Array Optional. Attachment objects to include on the email.

Attachments child properties

Property Type Description
Name String Required. Filename shown on the sent attachment.
ContentType String Optional. Attachment MIME type.
Content Stream Required at runtime. Attachment content stream. Older payloads that still send attachment bytes through compatible legacy properties are also accepted.

Response child properties

Property Type Description
Flowgear Object Default mutation metadata. Flowgear.IsSuccess indicates success or failure, Flowgear.Message contains the surfaced result message, and Flowgear.Request contains the sender input without binary attachment content.
messageId String Gmail message ID returned for the sent email.
threadId String Gmail thread ID returned for the sent email.
labelIds Array Gmail label IDs returned on the sent message.
providerCode String Provider-specific machine-readable error code when Gmail returns one.
providerStatus String Provider-specific status text when Gmail returns one.
response Object Raw Gmail API send response for successful requests.

Usage Notes

  • The sender keeps the Microsoft Email-style request field names so existing Workflow payloads can switch providers more easily.
  • One invalid or failed Email item does not stop the Node from returning a response row for later items in the same request stream.
  • Successful mutation rows use the Flowgear object instead of top-level default status fields.
  • Provider-specific failure detail is preserved in providerCode and providerStatus when Gmail returns it.
  • The sender runs on the CloudRuntime cluster.