Skip to Content

Gmail (Beta) connector for Jitterbit Integration Studio

Summary

The Gmail (Beta) connector establishes access to Gmail.

The Gmail (Beta) connector provides an interface for creating a Gmail (Beta) connection, the foundation used for generating instances of Gmail (Beta) activities. These activities, once configured, interact with Gmail through the connection.

The Gmail (Beta) connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

Note

This connector is currently in beta. To provide feedback, contact the Jitterbit Product Team.

Connector overview

This connector is used to first configure a Gmail (Beta) connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Gmail (Beta) connection and its activities are referred to as a Gmail (Beta) endpoint:

Gmail activity types

  • Send Email: Sends an email with Gmail and is intended to be used as a target in an operation.

  • Read Email: Retrieves emails from Gmail and is intended to be used as a source in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Endpoints created with this connector are included in endpoint usage reporting and count toward your license.

Prerequisites and supported API versions

The Gmail (Beta) connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Gmail (Beta) connector uses the Gmail API. Refer to the API documentation for information on the schema nodes and fields.

To use 3-legged OAuth 2.0 (3LO) authentication or Google Cloud service account authentication with the Gmail (Beta) connector, additional prerequisites are required. Agent version 10.83 / 11.21 or later is required to use 3LO.

Note

If S/MIME encryption is required, refer to Google's Turn on hosted S/MIME for message encryption guide.

Troubleshooting

If you experience issues with the Gmail (Beta) connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.

  4. If using private agents, you can enable connector verbose logging for this connector by adding this logger configuration entry to your private agent's logback.xml file:

    <logger name="org.jitterbit.connector.gmail" level="DEBUG"/>

    For more information on connector verbose logging, see Verbose logging for connectors using Jitterbit private agents.

  5. If using private agents, you can check the agent logs for more information.