Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Gmail

Email service by Google

CategoryCommunication
AuthenticationOAuth 2.0, custom
Version0.16.0
Published scopes5 published scopes
Last updatedSeptember 19, 2026

Overview

Connect Gmail with Flows360

Email service by Google

Use the Gmail connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 37 actions and 4 triggers.

Available actions

  • Send Email
  • Request Approval in Email
  • Reply to Email
  • Create Draft Reply
  • Get Email
  • Find Email
  • Send Email
  • Reply to Thread
  • Plus 29 additional declared actions.

Available triggers

  • New Email
  • New Labeled Email
  • New Attachment
  • New Label

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Gmail
  • Package: @activepieces/piece-gmail@0.16.0
  • Exact artifact digest: sha256:3bb4149e8fc658149acee40656e4f86653423b0396602b9b1063823893db923d
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

OAUTH2, CUSTOM AUTH. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Send Email (send_email), Send an email through a Gmail account Classification: read.
  • Request Approval in Email (request_approval_in_mail), Send approval request email and then wait until the email is approved or disapproved Classification: read.
  • Reply to Email (reply_to_email), Reply to an existing email. Classification: read.
  • Create Draft Reply (create_draft_reply), Creates a draft reply to an existing email. Classification: read.
  • Get Email (gmail_get_mail), Get an email via Id. Classification: read.
  • Find Email (gmail_search_mail), Find emails using advanced search criteria. If no filters are provided, the latest emails are returned. Classification: read.
  • Send Email (gmail_send_email), Send an email through a Gmail account Classification: read.
  • Reply to Thread (gmail_reply_to_thread), Reply to an existing email thread. Classification: read.
  • Get Message (gmail_get_message), Get a single email message by its ID. Classification: read.
  • Search Email (gmail_search_email), Search emails using advanced criteria. If no filters are provided, the latest emails are returned. Classification: read.
  • Get Thread (gmail_get_thread), Get a thread from your Gmail account via Id Classification: read.
  • Create Draft (gmail_create_draft), Create a new draft email (optionally inside an existing thread). Classification: read.
  • Update Draft (gmail_update_draft), Replace the content of an existing draft email. Classification: read.
  • Send Draft (gmail_send_draft), Send an existing draft email by its ID. Classification: read.
  • Get Draft (gmail_get_draft), Get a single draft email by its ID. Classification: read.
  • List Drafts (gmail_list_drafts), List draft emails in the mailbox. Classification: read.
  • Delete Draft (gmail_delete_draft), Permanently delete a draft email by its ID. Classification: read.
  • List Threads (gmail_list_threads), List email conversation threads in the mailbox. Classification: read.
  • Get Attachment (gmail_get_attachment), Download an email attachment by message ID and attachment ID. Classification: read.
  • Forward Message (gmail_forward_message), Forward an existing email to new recipients. Classification: read.
  • List Labels (gmail_list_labels), List all labels in the mailbox. Classification: read.
  • Get Label (gmail_get_label), Get a single label by its ID, including message and thread counts. Classification: read.
  • Get Profile (gmail_get_profile), Get the connected mailbox profile. Classification: read.
  • List History (gmail_list_history), List mailbox changes since a given history ID. Classification: read.
  • Stop Watch (gmail_stop_watch), Stop push notifications on the mailbox. Classification: read.
  • Create Label (gmail_create_label), Create a new label in the mailbox. Classification: read.
  • Add Label to Email (gmail_add_label_to_email), Apply a label to an email message. Classification: read.
  • Remove Label From Email (gmail_remove_label_from_email), Remove a label from an email message. Classification: read.
  • Archive Email (gmail_archive_email), Archive an email message by removing it from the inbox. Classification: read.
  • Archive Message (gmail_archive_message), Archive an email message by removing it from the inbox. Classification: read.
  • Get or Create Label (gmail_get_or_create_label), Get an existing label by name, creating it first if it does not exist. Classification: read.
  • Modify Labels (gmail_modify_labels), Add and/or remove labels across one or more email messages in a single call. Classification: read.
  • Trash Message (gmail_trash_message), Move an email message to Trash. Classification: read.
  • Untrash Message (gmail_untrash_message), Restore an email message from Trash. Classification: read.
  • Update Label (gmail_update_label), Rename, recolor, or change the visibility of a user label. Classification: read.
  • Modify Thread Labels (gmail_modify_thread_labels), Add and/or remove labels across every message in a thread in a single call. Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • New Email, polling.
  • New Labeled Email, polling.
  • New Attachment, polling.
  • New Label, polling.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

AuthenticationOAuth 2.0, custom
Supported objects41
Supported actionsNot published
Triggers4

Authentication

Authentication method: OAuth 2.0, custom

Required scopes

https://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.readonlyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.modifyemail

Authentication profiles

connection · oauth2

OAuth scopes: https://www.googleapis.com/auth/gmail.send, https://www.googleapis.com/auth/gmail.readonly, https://www.googleapis.com/auth/gmail.compose, https://www.googleapis.com/auth/gmail.modify, email

connection_2 · custom
  • Service Account JSON Key Required
  • User Email Required

Supported objects

ObjectReadWriteNotes
Send Email Yes No Send an email through a Gmail account
Request Approval in Email Yes No Send approval request email and then wait until the email is approved or disapproved
Reply to Email Yes No Reply to an existing email.
Create Draft Reply Yes No Creates a draft reply to an existing email.
Get Email Yes No Get an email via Id.
Find Email Yes No Find emails using advanced search criteria. If no filters are provided, the latest emails are returned.
Send Email Yes No Send an email through a Gmail account
Reply to Thread Yes No Reply to an existing email thread.
Get Message Yes No Get a single email message by its ID.
Search Email Yes No Search emails using advanced criteria. If no filters are provided, the latest emails are returned.
Get Thread Yes No Get a thread from your Gmail account via Id
Create Draft Yes No Create a new draft email (optionally inside an existing thread).
Update Draft Yes No Replace the content of an existing draft email.
Send Draft Yes No Send an existing draft email by its ID.
Get Draft Yes No Get a single draft email by its ID.
List Drafts Yes No List draft emails in the mailbox.
Delete Draft Yes No Permanently delete a draft email by its ID.
List Threads Yes No List email conversation threads in the mailbox.
Get Attachment Yes No Download an email attachment by message ID and attachment ID.
Forward Message Yes No Forward an existing email to new recipients.
List Labels Yes No List all labels in the mailbox.
Get Label Yes No Get a single label by its ID, including message and thread counts.
Get Profile Yes No Get the connected mailbox profile.
List History Yes No List mailbox changes since a given history ID.
Stop Watch Yes No Stop push notifications on the mailbox.
Create Label Yes No Create a new label in the mailbox.
Add Label to Email Yes No Apply a label to an email message.
Remove Label From Email Yes No Remove a label from an email message.
Archive Email Yes No Archive an email message by removing it from the inbox.
Archive Message Yes No Archive an email message by removing it from the inbox.
Get or Create Label Yes No Get an existing label by name, creating it first if it does not exist.
Modify Labels Yes No Add and/or remove labels across one or more email messages in a single call.
Trash Message Yes No Move an email message to Trash.
Untrash Message Yes No Restore an email message from Trash.
Update Label Yes No Rename, recolor, or change the visibility of a user label.
Modify Thread Labels Yes No Add and/or remove labels across every message in a thread in a single call.
Custom API Call Yes No Make a custom API call to a specific endpoint
New Email Yes No polling trigger declared by the pinned package.
New Labeled Email Yes No polling trigger declared by the pinned package.
New Attachment Yes No polling trigger declared by the pinned package.
New Label Yes No polling trigger declared by the pinned package.

Triggers

New Email · Poll

Triggers when new mail is found in your Gmail inbox

Inputs

  • subject · string
  • from · string
  • to · string
  • label · string
  • category · string
New Labeled Email · Poll

Triggers when a label is added to an email

Inputs

  • label · string
New Attachment · Poll

Triggers when an email with an attachment arrives.

Inputs

  • from · string
  • to · string
  • subject · string
  • label · string
  • category · string
  • filenameExtension · string
New Label · Poll

Triggers when a new label is created.

Setup

Setup

  1. Add the Gmail connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • Service Account JSON Key (serviceAccount), required.
  • User Email (userEmail), required.

OAuth scopes

  • https://www.googleapis.com/auth/gmail.send
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.compose
  • https://www.googleapis.com/auth/gmail.modify
  • email
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-gmail@0.16.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 37 actions and 4 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Gmail connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-gmail@0.16.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com