Skip to content

Gmail

Reference5 minPractitionerAdd-on · Integration hub

Use Gmail through a saved Integration hub connection. The catalog includes 28 actions, listed below.

Use Gmail through a saved Integration hub connection. The catalog includes 28 actions, listed below.

Messaging and calls

Gmail

Authentication: OAuth 2.0 (authorize the provider or enter the details requested by the connection form)

Actions

ActionDescription
Batch modify messages
batch_modify_messages
Applies the same label changes (read, archive, label) to a batch of messages.
Create draft
create_draft
Saves an email as a draft for the user to review and send from Gmail.
Create label
create_label
Creates a Gmail label (e.g. one per client or deal stage).
Delete draft
delete_draft
Permanently deletes a draft.
Delete label
delete_label
Deletes a user label (messages keep existing, the label is removed).
Get draft
get_draft
Reads a draft: recipients, subject, decoded body and attachments.
Get label
get_label
Returns a label with its message and unread counts (e.g. unread count of INBOX).
Get message
get_message
Reads one email in full: headers, decoded plain-text body and attachment list.
Get message summary
get_message_summary
Returns a message's subject, sender, recipients, date and snippet without the body.
Get profile
get_profile
Returns the connected mailbox address and its totals.
Get thread
get_thread
Reads a whole conversation: every message with headers, decoded body and attachments, oldest first.
List drafts
list_drafts
Lists drafts, optionally filtered with Gmail search syntax.
List history
list_history
Lists mailbox changes (new messages, label changes) since a history ID, for incremental sync.
List labels
list_labels
Lists all system and user labels with their IDs.
List messages
list_messages
Searches the mailbox with Gmail search syntax and returns matching message IDs.
List send as
list_send_as
Lists the addresses the mailbox can send as, with display names and HTML signatures.
List threads
list_threads
Searches conversations (threads) with Gmail search syntax.
Modify message labels
modify_message_labels
Marks a message read/unread, archives, stars or (un)labels it.
Modify thread labels
modify_thread_labels
Applies label changes (read, archive, label) to every message in a conversation.
Reply to email
reply_to_email
Replies inside an existing Gmail conversation so the answer threads correctly for everyone.
Send draft
send_draft
Sends an existing draft.
Send email
send_email
Sends a new email (with optional HTML and Beezr attachments) from the connected Gmail account.
Trash message
trash_message
Moves a message to the trash.
Trash thread
trash_thread
Moves a whole conversation to the trash.
Untrash message
untrash_message
Restores a message from the trash.
Untrash thread
untrash_thread
Restores a conversation from the trash.
Update draft
update_draft
Replaces the content of an existing draft.
Update label
update_label
Renames a user label or changes its visibility or color.

Open Integration hub, choose Gmail, and create a named connection. If the connection opens the provider’s consent page, sign in and authorize access. If it opens a connection form, fill the requested OAuth details and save. The provider configuration determines which route is used.

For the shared connection process, follow Connect an app.

Add an Integration step. Choose the app, saved connection and action, then map the action inputs from your record or workflow data.

The action list comes from the integration catalog. The connection form supplies the provider-specific input fields.