Skip to main content
Gmail
Gmail
42 actions · 1 auth method
Messaging

Authentication

OAuth 2.0

The steps in this guide require Admin or Owner privileges within Google Cloud.Guides: Connector Profile, Link Account
Actions
42 actions
Action
Description
Required scopes
Get Attachment
Download the base64url-encoded binary content of a specific email attachment by providing the parent message ID and the…
List Drafts
Retrieve a paginated list of all draft emails saved in the authenticated user’s Gmail account, returning draft IDs and b…
Get Draft
Retrieve the full content of a specific draft email by its draft ID, with configurable response format to control the ve…
Create Draft
Create and save a new unsent email draft in Gmail using RFC 2822 formatted message content encoded as base64url, without…
Update Draft
Fully replace the content of an existing draft by providing a new RFC 2822 message payload, enabling changes to recipien…
Send Draft
Immediately send a previously saved draft email to all its recipients, removing it from the Drafts folder and placing th…
Delete Draft
Permanently and irrecoverably delete a draft email by its draft ID, removing it from the Drafts folder immediately with…
List Filters
Retrieve all email filter rules configured in the Gmail account that automatically process incoming messages based on cr…
Get Filter
Retrieve the complete configuration of a specific Gmail filter rule by its ID, including the full matching criteria defi…
Create Filter
Create a new Gmail filter rule that automatically processes future incoming messages matching specified criteria, applyi…
Delete Filter
Permanently remove a Gmail filter rule by its ID, immediately stopping all future automatic processing of incoming messa…
List History
Retrieve a chronological log of all mailbox changes since a specific historyId checkpoint, enabling efficient incrementa…
List Labels
Retrieve the complete list of Gmail labels in the authenticated user’s mailbox, including both built-in system labels an…
Get Label
Retrieve the complete metadata for a specific Gmail label by its ID, including message and thread counts, sidebar visibi…
Create Label
Create a new custom Gmail label for organizing email messages, with options to set its display name, sidebar visibility,…
Update Label
Partially update an existing Gmail label’s name, visibility settings, or color using a PATCH request that only modifies…
Delete Label
Permanently remove a custom Gmail label by its ID - all messages that had this label are preserved with the label stripp…
List Messages
Retrieve a paginated list of email messages from the authenticated user’s Gmail mailbox, returning message IDs and threa…
Get Message
Retrieve the complete content and metadata of a specific Gmail message by its ID, including all headers, body parts, and…
Send Message
Immediately send a new email message via Gmail by providing the complete RFC 2822 formatted message content encoded as a…
Delete Message
Permanently and irreversibly delete a Gmail message by its ID, bypassing the Trash folder entirely - use trash_message i…
Modify Message
Add or remove Gmail labels on a specific message in a single call to star it, mark it as read or unread, move it to inbo…
Trash Message
Move a Gmail message to the Trash folder so it can be recovered within 30 days - a safe, reversible alternative to the p…
Untrash Message
Restore a previously trashed Gmail message back to the inbox by removing the TRASH label and restoring INBOX, reversing…
List Forwarding Addresses
Retrieve all email forwarding addresses registered in the Gmail account settings, along with their verification status s…
Get Forwarding Address
Retrieve the details and verification status of a specific email forwarding address registered in Gmail settings, confir…
Get Auto-Forwarding Settings
Retrieve the current auto-forwarding configuration showing whether all incoming emails are being automatically forwarded…
Get IMAP Settings
Retrieve the current IMAP protocol settings for the Gmail account, including whether IMAP access is enabled for third-pa…
Update IMAP Settings
Update the Gmail IMAP protocol settings to enable or disable IMAP access for third-party email clients, and configure ho…
Get POP Settings
Retrieve the current POP3 protocol settings for the Gmail account, showing which messages are accessible via POP3 and wh…
Update POP Settings
Update the Gmail POP3 protocol settings to control which messages are downloadable by POP3 clients and what disposition…
List Send-As Aliases
Retrieve all send-as aliases configured for the Gmail account, including the primary address and any additional addresse…
Get Send-As Alias
Retrieve the complete configuration of a specific send-as alias by its email address, including the sender display name,…
Get Vacation Settings
Retrieve the current vacation responder (out-of-office auto-reply) configuration, including whether it is active, the me…
Update Vacation Settings
Enable, disable, or update the Gmail vacation responder (out-of-office auto-reply) with custom message content, an optio…
List Threads
Search and list email conversation threads from Gmail using full Gmail search syntax, with support for filtering by send…
Get Thread
Retrieve the complete email conversation thread including all messages in chronological order, with full MIME content, h…
Modify Thread
Apply or remove Gmail labels on every message in an entire conversation thread simultaneously, enabling efficient bulk o…
Delete Thread
Permanently and irreversibly delete an entire email thread and all its messages by thread ID, bypassing Trash - use tras…
Trash Thread
Move an entire email conversation thread and all its messages to the Gmail Trash folder, where it can be recovered withi…
Untrash Thread
Restore a trashed email thread and all its messages back to the inbox by removing the TRASH label and restoring INBOX on…
Get User Profile
Retrieve the authenticated user’s Gmail profile including their primary email address, total mailbox message and thread…

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/gmail/filled/png

Connector Profile

Gmail - OAuth 2.0
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/gmail/filled/png

Link Account

Gmail - OAuth 2.0
4

Use Actions

Invoke actions using one of the methods below: