Gmail Connection
See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Gmail connector.
This topic describes how to authenticate to Gmail and configure any necessary connection properties in the Gmail connection connector.
Prerequisites
Enable the Gmail API
Follow these steps to enable the Gmail API:
Navigate to the Google Cloud Console.
Select Library from the left-hand navigation menu. This opens the Library page.
In the search field, enter “Gmail API” and select Gmail API from the search results.
On the Gmail API page, click ENABLE.
Connection Configuration
Each connection property available in the Gmail connector is explained below.
Connection Name
The name of the connection to be created should be provided. This is the name that will display on the list of available connections.
Auth Scheme
The type of authentication to use when connecting to Gmail.
Possible Values
OAuth2
Set this to use OAuth2 authentication.
If OAuth2 is selected, additional configuration parameters will get listed.
API
Choose the preferred API to interact with Gmail, either REST or IMAP.
Client ID
The client ID assigned when you register your application with an OAuth authorization server.
Client Secret
The client secret assigned when you register your application with an OAuth authorization server.
Refresh Token
The OAuth refresh token for the corresponding OAuth access token.
Service Account
Set this to use Service Account as authentication.
If Service Account is selected, additional configuration parameters will get listed.
API
Choose the preferred API to interact with Gmail, either REST or IMAP.
Certificate Type
The type of key store containing the Service Account Certificate.
Possible Values
PFX
Set this to use a certificate with type as P12, for authentication.
If PFX is selected, additional configuration parameters will get listed.
Certificate Issuer: Set this to the email address of the service account. This address will usually include the domain iam.gserviceaccount.com.
Certificate Password: Set this to the .pfx file password. In most cases you must provide this since Google encrypts PFX certificates.
JSON
Set this to use a certificate with type as JSON, for authentication.
If JSON is selected, proceed by uploading the keystore file.
Upload File
Upload Service Account Certificate. Use JSON file if Certificate Type is JSON, else use PFX(P12).
Username
Set this to the user of the Gmail account of the user you are connecting to. This is required when using IMAP API or using PFX file of service account.
Add Configuration: Additional properties can be added using this option as key-value pairs.
After entering all the details, click on the TEST button.
If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.
Click on the CREATE button to save the changes.
If the details are incorrect or the server is down, you will get a message “Connection unavailable”.
If you have any feedback on Gathr documentation, please email us!