Gmail Sender

Sends one or more email messages through Gmail by using a Google OAuth Connection.

Revision History

0.0.0.7 - Initial release.

Connection

Use this Connection to store the Google OAuth client registration and Gmail tokens used by the Gmail sender and listener Nodes.

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

Setup Notes

  1. In Google Cloud, enable the Gmail API and create an OAuth client for the Gmail account you want to use.
  2. Add the Flowgear OAuth redirect URI shown by the Connection designer to the OAuth client's allowed redirect URI list.
  3. In the Flowgear Console, create a Connection of type Gmail, enter Client Id and Client Secret, then click Connect your Account.
  4. Complete the Google sign-in and consent flow. The Connection requests offline access and consent prompts so Google can return a Refresh Token for long-lived runtime use.
  5. Leave Scopes at its default value unless you have a specific reason to change it. The default scope is https://www.googleapis.com/auth/gmail.modify.
  6. Test the Connection after authorization to confirm Flowgear can authenticate against Gmail.

Methods

The Node exposes one sender method. It keeps the Microsoft Email request field names so you can switch providers without redesigning your message payload.

SendEmail

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

Parameter Type Description
Connection Connection The Gmail OAuth Connection used to authenticate the 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 normalized response row per Email item. Successful rows include messageId, threadId, labelIds, and the raw Gmail response. Failed rows include provider error details when Gmail returns them.

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. The email subject line.
Body String Required. The email body content.
HtmlBody Boolean Optional. Set to true when Body contains HTML.
Attachments Array Optional. One or more attachment objects.

Attachments child properties

Property Type Description
Name String Required. The filename to show on the email attachment.
ContentType String Optional. The attachment MIME type.
Content Stream Required at runtime. The attachment content stream. Older payloads that send attachment data through ContentBytes, Data, or content are also accepted.

Response child properties

Property Type Description
messageId String The Gmail message ID returned for the sent email.
threadId String The Gmail thread ID that contains the sent email.
labelIds Array The Gmail label IDs applied to the sent email in the provider response.
providerCode String Provider-specific error code, when Gmail returns one.
providerStatus String Provider-specific status text, when Gmail returns one.
providerReason String Provider-specific failure reason, when Gmail returns one.
httpStatusCode Integer The HTTP status code returned by Gmail for failed requests, when available.
response Object The raw Gmail API response object for the send operation.

Usage Notes

  • Set HtmlBody to true when Body contains HTML content.
  • The sender returns one response row per Email item, so one failed message does not prevent other items from being reported.
  • Gmail Sender runs on the CloudRuntime cluster.