Gmail

Send, reply, search, and read emails in Gmail. Create drafts, request approvals, and manage your inbox.

CommunicationOAuth7 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (7)
create_draft_reply
custom_api_call
gmail_get_mail
gmail_search_mail
reply_to_email
request_approval_in_mail
send_email
Details

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

Scopes requested: https://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.readonlyhttps://www.googleapis.com/auth/gmail.compose

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("gmail", "create_draft_reply", {
    "message_id": "<message_id>",
    "reply_type": "reply",
    "body_type": "plain_text",
    "include_original_message": true
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Gmail answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "gmail-create-draft-reply",
  name: "Gmail: Create Draft Reply",
  description: "Calls Gmail when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("gmail", {
      "action": "create_draft_reply",
      "message_id": "<message_id>",
      "reply_type": "reply",
      "body_type": "plain_text",
      "include_original_message": true
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/gmail/create_draft_reply" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"message_id":"<message_id>","reply_type":"reply","body_type":"plain_text","include_original_message":true}}'

Actions

create_draft_replyin catalog

Create Draft Reply. Creates a draft reply to an existing email.

Input	Type	Description
`message_id`required	id (picked from your account)	Select a message from the list or enter a message ID manually.
`reply_type`required	one of "reply" \| "reply_all"	Choose whether to reply to sender only or to all recipients
`body_type`required	one of "plain_text" \| "html"	Body Type
`body`optional	long text	Your draft reply message content
`include_original_message`required	boolean	Include the original message content in the draft reply
`sender_name`optional	text	Optional sender name to display
`attachment`optional	file	Optional file to attach to your draft reply
`attachment_name`optional	text	Custom name for the attachment

custom_api_callin catalog

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

gmail_get_mailin catalog

Get Email. Get an email via Id.

Input	Type	Description
`message_id`required	text	The messageId of the mail to read.

gmail_search_mailin catalog

Find Email. Find emails using advanced search criteria. At least one search filter (from, to, subject, label, category, date, content, or attachment) is required.

Input	Type	Description
`from`optional	text	Optional filteration, leave empty to filter based on the email sender
`to`optional	text	Optional filteration, leave empty to filter based on the email recipient
`subject`optional	text	The email subject
`content`optional	text	Search for specific text within email body
`has_attachment`optional	boolean	Only find emails with attachments
`attachment_name`optional	text	Search for emails with specific attachment filename
`label`optional	id (picked from your account)	Optional filteration, leave unselected to filter based on the email label
`category`optional	one of "primary" \| "social" \| "promotions" \| "updates" \| "forums" \| "reservations" \| "purchases"	Optional filteration, leave unselected to filter based on the email category
`after_date`optional	date-time (ISO)	Find emails sent after this date
`before_date`optional	date-time (ISO)	Find emails sent before this date
`include_spam_trash`optional	boolean	Include emails from Spam and Trash folders in search results
`max_results`optional	number	Maximum number of emails to return (1-500)

reply_to_emailin catalog

Reply to Email. Reply to an existing email.

Input	Type	Description
`message_id`required	id (picked from your account)	Select a message from the list or enter a message ID manually.
`reply_type`required	one of "reply" \| "reply_all"	Choose whether to reply to sender only or to all recipients
`body_type`required	one of "plain_text" \| "html"	Body Type
`body`required	long text	Your reply message content
`sender_name`optional	text	Optional sender name to display
`attachment`optional	file	Optional file to attach to your reply
`attachment_name`optional	text	Custom name for the attachment

request_approval_in_mailin catalog

Request Approval in Email. Send approval request email and then wait until the email is approved or disapproved

Input	Type	Description
`receiver`required	text	The email address of the recipient who will receive the approval request.
`cc`optional	array	The email addresses of the recipients who will receive a carbon copy of the approval request.
`bcc`optional	array	The email addresses of the recipients who will receive a blind carbon copy of the approval request.
`subject`required	text	The subject of the approval request email.
`body`required	text	Body for the email you want to send
`reply_to`optional	array	Email address to set as the "Reply-To" header
`sender_name`optional	text	Sender Name
`from`optional	text	The address must be listed in your GMail account's settings
`in_reply_to`optional	text	Reply to this Message-ID

send_emailin catalog

Send Email. Send an email through a Gmail account

Input	Type	Description
`receiver`required	array	Receiver Email (To)
`cc`optional	array	CC Email
`bcc`optional	array	BCC Email
`subject`required	text	Subject
`body_type`required	one of "plain_text" \| "html"	Body Type
`body`required	text	Body for the email you want to send
`reply_to`optional	array	Email address to set as the "Reply-To" header
`sender_name`optional	text	Sender Name
`from`optional	text	The address must be listed in your GMail account's settings
`attachments`optional	array	Attachments
`in_reply_to`optional	text	Reply to this Message-ID
`draft`required	boolean	Create draft without sending the actual email

Details

Id: gmail
Category: Communication
Tags: email, google, inbox, mail, send, read
Package: @activepieces/piece-gmail@0.11.6
Tier: Built in