# Gmail

<!-- BEGIN GENERATED:intro -->

The Gmail connector is a [Palantir-provided driver](../../data-integration/foundry-provided-drivers/index.md) for Gmail.

To create a new Gmail source, follow the [standard setup flow for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#setup), then use the sections below for Gmail-specific configuration and networking. For the complete property reference, see the [official Gmail driver documentation ↗](https://cdn.cdata.com/help/DLM/jdbc/pg_connectionj.htm).

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

## Supported capabilities

| Capability | Status |
|---|---|
| Exploration | 🟢 Generally available |
| Batch syncs | 🟢 Generally available |
| Incremental | 🟢 Generally available |
| [OAuth 2.0 authentication](#oauth-20-authentication) | 🟢 Generally available |
| [Table exports](#table-exports) | 🟢 Generally available |

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`Schema` ↗](https://cdn.cdata.com/help/DLM/jdbc/RSBGmail_p_Schema.htm) | Mandatory | Used to specify what Gmail Api to use, either REST (default) or IMAP. | `REST` |
| [`AuthScheme` ↗](https://cdn.cdata.com/help/DLM/jdbc/RSBGmail_p_AuthScheme.htm) | Recommended | The type of authentication to use when connecting to Gmail. | `OAuthJWT` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/DLM/jdbc/RSBGmail_p_InitiateOAuth.htm) | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | `GETANDREFRESH` |
| [`OAuthClientId` ↗](https://cdn.cdata.com/help/DLM/jdbc/RSBGmail_p_OAuthClientId.htm) | Recommended | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. | — |
| [`OAuthClientSecret` ↗](https://cdn.cdata.com/help/DLM/jdbc/RSBGmail_p_OAuthClientSecret.htm) | Recommended | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. | — |
| [`OAuthJWTCert` ↗](https://cdn.cdata.com/help/DLM/jdbc/RSBGmail_p_OAuthJWTCert.htm) | Recommended | Supplies the name of the client certificate's JWT Certificate store. | — |
| [`OAuthJWTCertType` ↗](https://cdn.cdata.com/help/DLM/jdbc/RSBGmail_p_OAuthJWTCertType.htm) | Recommended | Identifies the type of key store containing the JWT Certificate. | `GOOGLEJSONBLOB` |
| [`OAuthJWTSubject` ↗](https://cdn.cdata.com/help/DLM/jdbc/RSBGmail_p_OAuthJWTSubject.htm) | Recommended | The user subject for which the application is requesting delegated access. | — |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## Networking

The table below lists the domains that the source must be able to access to run.

For each domain, add a corresponding [egress policy](../../administration/configure-egress/index.md). If the source is hosted on-premises and not directly reachable from Foundry, use an [agent proxy egress policy](../../administration/configure-egress/index.md#agent-proxy-egress-policies) instead. The agent host itself must also be able to reach the listed domains. See [using an agent as a proxy](../../data-connection/agent-proxy/index.md) for details.

| Domain  | Required |
|--- |--- |
| accounts.google.com | Always. Required for OAuth |
| googleapis.com | Always |

<!-- END GENERATED:networking -->

<!-- BEGIN GENERATED:oauth -->

## OAuth 2.0 authentication

This connector supports OAuth 2.0 authentication. Follow the [OAuth 2.0 guidance for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#oauth-20-authentication) to configure and authorize the connection.

<!-- END GENERATED:oauth -->

<!-- BEGIN GENERATED:table-exports -->

## Table exports

This connector supports table exports. Learn how to [set up a table export](../../data-connection/export-overview/index.md#table-exports).

<!-- END GENERATED:table-exports -->