From Name

Reply-To

Drafts

The user's e-mail address. If it is empty, the special value 'me' will be used to indicate the authenticated user.

The message id to reply to (inclusive of bracket and domain) e.g <1234@gmail.com>

In-Reply-To

List of message ids of all previous messages in the thread to maintain conversation history (each item should include bracket and domain) e.g e.g <1234@gmail.com>

References

Parameters

Emails

Labels

Gmail

Download Attachment

Get Profile

Gmail Users Get Profile

Set up or update a push notification watch on the given user mailbox.

Gmail Users Watch

Stop receiving push notifications for the given user mailbox.

Gmail Users Stop

Immediately and permanently deletes the specified draft. Does not simply trash it.

Gmail Users Drafts Delete

Gmail Users Drafts Get

Gmail Users Drafts Update

Creates a new draft with the `DRAFT` label.

Gmail Users Drafts Create

Gmail Users Drafts List

Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers.

Gmail Users Drafts Send

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`).

Gmail Users History List

Moves the specified message to the trash.

Gmail Users Messages Trash

Removes the specified message from the trash.

Gmail Users Messages Untrash

Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.

Gmail Users Messages Delete

Gmail Users Messages Get

Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.

Gmail Users Messages Batch Delete

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message.

Gmail Users Messages Import

Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.

Gmail Users Messages Insert

Lists the messages in the user's mailbox.

Gmail Users Messages List

Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. For example usage, see [Sending email](https://developers.google.com/gmail/api/guides/sending).

Gmail Users Messages Send

Modifies the labels on the specified message.

Gmail Users Messages Modify

Modifies the labels on the specified messages.

Gmail Users Messages Batch Modify

Gmail Users Messages Attachments Get

Gmail Users Labels Create

Gmail Users Labels List

Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.

Gmail Users Labels Delete

Gmail Users Labels Get

Gmail Users Labels Update

Gmail Users Labels Patch

Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash.

Gmail Users Threads Trash

Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash.

Gmail Users Threads Untrash

Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer `threads.trash` instead.

Gmail Users Threads Delete

Gmail Users Threads Get

Gmail Users Threads List

Modifies the labels applied to the thread. This applies to all messages in the thread.

Gmail Users Threads Modify

Gmail Users Settings Get Imap

Gmail Users Settings Update Imap

Gmail Users Settings Get Pop

Gmail Users Settings Update Pop

Gmail Users Settings Get Vacation

Gmail Users Settings Update Vacation

Gmail Users Settings Get Language

Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.

Gmail Users Settings Update Language

Gets the auto-forwarding setting for the specified account.

Gmail Users Settings Get Auto Forwarding

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Update Auto Forwarding

Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.

Gmail Users Settings Send As List

Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Send As Create

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

Gmail Users Settings Send As Get

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.

Gmail Users Settings Send As Update

Gmail Users Settings Send As Patch

Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Send As Delete

Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Send As Verify

Lists S/MIME configs for the specified send-as alias.

Gmail Users Settings Send As Smime Info List

Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.

Gmail Users Settings Send As Smime Info Insert

Gets the specified S/MIME config for the specified send-as alias.

Gmail Users Settings Send As Smime Info Get

Deletes the specified S/MIME config for the specified send-as alias.

Gmail Users Settings Send As Smime Info Delete

Sets the default S/MIME config for the specified send-as alias.

Gmail Users Settings Send As Smime Info Set Default

Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity.

Gmail Users Settings Cse Identities Create

Lists the client-side encrypted identities for an authenticated user.

Gmail Users Settings Cse Identities List

Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration.

Gmail Users Settings Cse Identities Delete

Retrieves a client-side encryption identity configuration.

Gmail Users Settings Cse Identities Get

Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887).

Gmail Users Settings Cse Identities Patch

Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.

Gmail Users Settings Cse Keypairs Create

Lists client-side encryption key pairs for an authenticated user.

Gmail Users Settings Cse Keypairs List

Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method.

Gmail Users Settings Cse Keypairs Disable

Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities.

Gmail Users Settings Cse Keypairs Enable

Retrieves an existing client-side encryption key pair.

Gmail Users Settings Cse Keypairs Get

Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages.

Gmail Users Settings Cse Keypairs Obliterate

Lists the message filters of a Gmail user.

Gmail Users Settings Filters List

Creates a filter. Note: you can only create a maximum of 1,000 filters.

Gmail Users Settings Filters Create

Gmail Users Settings Filters Get

Immediately and permanently deletes the specified filter.

Gmail Users Settings Filters Delete

Lists the forwarding addresses for the specified account.

Gmail Users Settings Forwarding Addresses List

Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted`. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Forwarding Addresses Create

Gmail Users Settings Forwarding Addresses Get

Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Forwarding Addresses Delete

Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Delegates List

Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same Google Workspace organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a Google Workspace organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Delegates Create

Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Delegates Get

Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.

Gmail Users Settings Delegates Delete

Microsoft Outlook

# Send Email

This scenario allows your application to send emails using Gmail or Outlook. The email fields will be mapped from the schema supported by your application to the application-specific schema.

## How It Works

- Make an API request via REST API or the Integration.app SDK with the data required to send the email.
- The email data from your application is transformed into a format compatible with the selected external application (Gmail or Outlook).


Send Email

Send an email via Gmail or Microsoft Outlook

HubSpot

Microsoft Dynamics 365

Keap

SugarCRM

Outreach

ActiveCampaign

Salesloft

SalesForce Pardot

Front

Close

Whatsapp

Recruitee

# Realtime Full two-way Sync of Emails

This scenario enables your application to fully sync Emails between your app and any external application in both directions. It handles the initial import/export of Emails and then sends events when a Email is created, updated, or deleted on any side, as close to real-time as possible.

Email fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Emails in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Emails to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Emails

Bi-directional realtime sync of Emails with records deduplication

# Create Email

This scenario allows your application to create a Email in any external application in the same way. 
You will pass Email fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Email with and configure mapping to our default model

2. **Create Email API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Email data into a format compatible with the selected external application.
   - It then makes an API call to create the Email in that specific application.


Create Email

Creates Email in any external application

# Get all Emails

This scenario enables your application to get a complete list of Emails from any external application to your app's API in the same way. 

When receiving Emails data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Emails along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Emails page by page.


Get all Emails

Imports all Emails from any external application to your App.

# Continuous Import of Emails to Your App

This scenario enables your application to continuously sync Emails from any external application to your app's API. It handles the initial import of Emails and keeps them synchronized when a Email is created, updated, or deleted in the external application.

When receiving Emails data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Emails to my App

Import Emails and receive created/updated or deleted events

# Delete Email

This scenario allows your application to delete a Email from any external application. 
You will pass ID of the Email you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Email API call**:
   - Call Integration.app REST API or SDK with ID of the Email you want to delete and Integration.app will send the correct request to the external app.


Delete Email

Deletes Email in any external application

# Update Email

This scenario allows your application to update a Email in any external application in the same way. 
You will pass  ID of the Email you want to update and Email fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Email with and configure mapping to our default model

2. **Create Email API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Email data into a format compatible with the selected external application.
   - It then makes an API call to update the Email in that specific application.


Update Email

Updates Email in any external application

The ID of the mailbox's current history record

The total number of messages in the mailbox.

The total number of threads in the mailbox

Field Name	API Key	Type	Description
Email Address	emailAddress	string	The user's email address
Messages Total	messagesTotal	integer	The total number of messages in the mailbox.
Threads Total	threadsTotal	integer	The total number of threads in the mailbox
History Id	historyId	string	The ID of the mailbox's current history record

Gmail API Integration Profile

Get Profile in Gmail API

Build every single integration your customers need with AI