Help Center

Menu

Gmail

The Gmail Component is designed to establish a connection with Google Gmail, utilizing both low-level REST API calls and high-level Google API client.

The current release of the component supports API version v1.

Google preparations

Before building any integration flow, you must first configure the app from inside the Google Developers Console.

  1. To do this, go to the API & Service page and enable the following Gmail API.

  2. Go to the Credentials section and create a new credential of type OAuth client ID.

    1. Set Application type to Web application.

    2. Add Authorized redirect URI as: https://{your-tenant-address}/callback/oauth2. For example, https://app.connect.squiz.cloud/callback/oauth2

In the case of new domains, you may get a This app isn’t verified error. Read the Unverified apps help article for information on how to proceed.

Credentials

Now you can create new credentials for the component:

Type

A required dropdown. Choose OAuth2.

Choose Auth Client

A required dropdown. Select one of the previously created clients or choose Add New Auth Client:

Name

A required string. Provide any name you prefer.

Client ID

A required string. Use the Client ID from the Web application section in the Google Developers Console.

Client Secret

A required string. Use the Client Secret from the Web application section in the Google Developers Console.

Authorization Endpoint

A required string. Google OAuth2 authorization endpoint https://accounts.google.com/o/oauth2/v2/auth.

Token Endpoint

A required string. Google refresh token endpoint https://oauth2.googleapis.com/token.

Name Your Credential

A required string. Provide any name you want.

Scopes (Comma-separated list)

A required string. Enter the scopes to gain access to your Gmail. For example, https://www.googleapis.com/auth/gmail.readonly. For more information, refer to Google’s documentation.

Additional parameters (Comma-separated list)

A required string. Set it as access_type:offline,prompt:consent to ensure the proper functioning of the component.

Number of retries

An optional integer. The default is 5. Set how many times the component should retry making a request.

Delay between retries

An optional integer. The default is 10000 ms. Set how much time to wait before the next attempt.

To verify the credentials, you need to set any of the scopes that allow reading basic user data (profile). For example, https://www.googleapis.com/auth/gmail.readonly or broader scopes.

Triggers

This component does not have trigger functions, making it inaccessible as the first component during the integration flow design.

Actions

Gmail component includes the following actions: