Enables the ability to send update notifications like new messages received.

Get metadata about the authenticated user

Fetch events that have occurred in the mailbox since the specified startHistoryId.

Test Message

The Gmail component authenticates requests through the Google Cloud Platform (GCP) OAuth 2.0 service.
You'll need to create a GCP OAuth 2.0 app so your integration can authenticate and perform Gmail tasks on your customers' behalf.

To create a Gmail OAuth 2.0 app, first make sure you have a Google Developer account - you can sign up at [https://console.cloud.google.com/](https://console.cloud.google.com/).
Then:

1. Open up the Gmail API console - [https://console.cloud.google.com/marketplace/product/google/gmail.googleapis.com](https://console.cloud.google.com/marketplace/product/google/gmail.googleapis.com)
1. You will be prompted to enable **Gmail API** for your project. Click **ENABLE**.
1. On the sidebar, select **APIs & Services** and then **Credentials**.
1. An OAuth 2.0 app includes a "Consent Screen" (the page that asks "Do you want to allow (Your Company) to access Gmail on your behalf?"). Click **CONFIGURE CONSENT SCREEN**.
   1. Your app will be externally available to your customers, so choose a **User Type** of **External**.
   1. Fill out the OAuth consent screen with an app name (your company or product's name), support email, app logo, domain, etc.
   1. You can ignore domains for now.
   1. On the next page, add any scopes releavant to your integration, like `https://www.googleapis.com/auth/gmail.readonly` and `https://www.googleapis.com/auth/gmail.send`.
   1. Enter some **test users** for your testing purposes.
      Your app will only work for those testing users until it is "verified" by Google.
      When you are ready for verification (they verify your privacy policy statement, etc), click **PUBLISH APP** on the **OAuth consent screen**.
      That'll allow your customers to authorize your integration to access their Gmail account.
1. Once your "Consent Screen" is configured open the **Credentials** page from the sidebar again.
1. Click **+CREATE CREDENTIALS** and select **OAuth Client ID**.
   1. Under **Application type** select **Web application**.
   1. Under **Authorized redirect URIs** enter Prismatic's OAuth 2.0 callback URL: `https://oauth2.prismatic.io/callback` for US based integrations.
      1. For integrations outside the US refer to this [guide](https://prismatic.io/docs/connections/#creating-an-oauth-20-app-in-a-third-party-service) to find your region’s Callback URL.
   1. Click **CREATE**.
1. Take note of the **Client ID** and **Client Secret** that are generated.

:::info
Make sure to **publish** your OAuth 2.0 app after you've tested it so users outside of your _test users_ can authorize your integration to interact with Gmail on their behalf.
:::

Now that you have a **Client ID** and **Client Secret**, add Gmail step to your integration in Prismatic.
Open the **Configuration Wizard Designer** by clicking **Configuration Wizard**, select your **Gmail Connection** and enter your client ID and secret.

:::info A note on scopes
You can keep the default [Gmail scope](https://developers.google.com/gmail/api/auth/scopes), `https://mail.google.com/`.
This will grant you full permission over your users' Gmail accounts.

If you would like to limit permissions, you can select a subset of scopes, like `https://www.googleapis.com/auth/gmail.readonly https://www.googleapis.com/auth/gmail.send`.
:::


Manage Messages in Google's email service

[Gmail](https://gmail.com/) is Google's email service.
This component allows you to fetch and filter and manage messages, and send new messages from a Google Gmail account.

#### API Documentation

This component was built using the [Gmail API Documenetation](https://developers.google.com/gmail/api/guides).


Action Name	Action Description
Get Label by Name	Get a label (including ID) by its name
List Labels	List all labels within this account
Get Message	Get a message by ID
List Messages	Get a list of messages
Send Message	Send a new message
Trash Message	Send a message to the trash
Untrash Message	Remove a message from the trash
Update Message Labels	Add or remove labels from a message
Get Current User	Get metadata about the authenticated user
Raw Request	Send raw HTTP request to Google Gmail
Create Push Notification (Watch Request)	Enables the ability to send update notifications like new messages received.
Delete Push Notification (Stop Mailbox Updates)	Calls a stop notification.
Get Event History	Fetch events that have occurred in the mailbox since the specified startHistoryId.

Gmail Connector

Integrate with customers’ other SaaS apps, fast

About the Gmail Connector

Actions

Triggers

Ready to get started?