Gmail (Beta) connection

Introduction

A Gmail (Beta) connection, created using the Gmail (Beta) connector, establishes access to Gmail. Once a connection is configured, you can create instances of Gmail (Beta) activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a Gmail (Beta) connection

A new Gmail (Beta) connection is created using the Gmail (Beta) connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Endpoints page (see Create a global endpoint in Global Endpoints).

An existing Gmail (Beta) connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design Component Palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Endpoints page (see Edit a global endpoint in Global Endpoints).

Configure a Gmail (Beta) connection

Each user interface element of the Gmail (Beta) connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Gmail (Beta) connection and must not contain forward slashes / or colons :. This name is also used to identify the Gmail (Beta) endpoint, which refers to both a specific connection and its activities.

• Authentication: Select the method of authentication, either Authorization Code Grant (default) or Service Account.

  • Authorization Code Grant: Select this option to use 3-legged OAuth 2.0 (3LO) for authentication:

    • OAuth application: Select a Gmail (Beta) connector application configured in the Management Console App Registrations page. For more information on configuring a Gmail (Beta) connector application in the App Registrations page, refer to the Gmail 3-legged OAuth 2.0 (3LO) prerequisites.

    • Log in with Google Account: Click to authenticate through Google in a separate browser tab and provide consent for Jitterbit to access the Gmail application.

  • Service Account: Select this option to use a Google Cloud service account for authentication.

    • User email: Enter the email address to impersonate. Emails will appear to be sent from this email address.

    • Client email: Enter the service account email generated when the service account was created.

    • Private key: Enter the private key associated with the service account.

    • Scopes: Enter the Gmail scopes required by the service account in the Scopes table:

      Scope	Activity
      https://mail.google.com/	All
      https://www.googleapis.com/auth/gmail.modify	All
      https://www.googleapis.com/auth/gmail.compose	Send
      https://www.googleapis.com/auth/gmail.send	Send
      https://www.googleapis.com/auth/gmail.readonly	Read
      https://www.googleapis.com/auth/gmail.metadata	Read

      Click the add icon to add a row to the table and enter a scope value.

      To save the row, click the submit icon in the rightmost column.

      To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

      To delete all rows, click Clear All.

• Optional settings: Click to expand additional optional settings:

  • Connection Timeout: Enter the connection timeout value in milliseconds. The default value is 20000.

  • Read Timeout: Enter the read timeout value in milliseconds. The default value is 60000.

• Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Gmail (Beta) connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector Basics.

These activity types are available:

• 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.