Skip to end of metadata
Go to start of metadata

Introduction

An Email connection is configured using the Email connector, establishing access to an email server. Once a connection is established, you can configure one or more Email activities associated with that connection to be used either as a source (to provide data in an operation) or as a target (to consume data in an operation).

Creating or Editing an Email Connection

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

To configure a new Email connection, use the Show dropdown to filter on Connectors, and then click the Email connector block:

Email connection new

To configure an existing Email connection, use the Show dropdown to filter on Endpoints, and then double-click the Email connector block:

Email connection existing

These open the configuration screen for the Email connection, covered next.

Configuring an Email Connection

Configuration of an Email connection includes these fields:

Email connection configuration

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

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

  • Activity: Use the dropdown to select the activity types you want to associate with the connection:

    • Both: The connection will be associated with both Email activity types. When Both is selected, all of fields documented below are displayed.
    • Send Email: The connection will be associated with only the Send Email activity type. When Send Email is selected, only the fields that begin with SMTP documented below are displayed.
    • Read Email: The connection will be associated with only the Read Email activity type. When Read Email is selected, only the fields that begin with IMAP documented below are displayed.
  • SMTP Host: Enter the hostname of the SMTP email server with which to connect. This field is displayed only if the Activity type selected above is Both or Send Email.

  • SMTP Port: Enter the port number of the SMTP email server with which to connect. The default port is 25. A value in this field is applicable only if the SMTP Security field below is set to None or TLS. If the SMTP Security field is set to SSL, then port 465 is always used regardless of the value entered in the SMTP Port field. This field is displayed only if the Activity type selected above is Both or Send Email.

  • SMTP Security: Use the dropdown to select one of None, SSL, or TLS. This field is displayed only if the Activity type selected above is Both or Send Email.

    • None: The email server does not require authentication.
    • SSL: The email server uses SSL encryption for authentication. When this option is selected, if a value in the SMTP Port field is provided, it is ignored and port 465 is used instead.
    • TLS: The email server uses TLS encryption for authentication.
  • SMTP Username: Enter the username (if required by the SMTP email server).

  • SMTP Password: Enter the password (if required by the SMTP email server).

  • IMAP Host: Enter the hostname of the IMAP email server with which to connect. This field is displayed only if the Activity type selected above is Both or Read Email.

  • IMAP Port: Enter the port number of the IMAP email server with which to connect. The default port is 993. This field is displayed only if the Activity type selected above is Both or Read Email.

  • IMAP Security: Use the dropdown to select one of None, SSL, or TLS. This field is displayed only if the Activity type selected above is Both or Read Email.

    • None: The email server does not require authentication.
    • SSL: The email server uses SSL encryption for authentication.
    • TLS: The email server uses TLS encryption for authentication.
  • IMAP Username: Enter the username (if required by the IMAP email server).

  • IMAP Password: Enter the password (if required by the IMAP email server).

  • Test: Click to verify the connection using the provided configuration. The username and password fields for a given protocol are used for verification only if both are present and the security field is set to either SSL or TLS.

  • 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 an Email connection has been created, menu actions for that connection are accessible from the project pane's Components tab. See Connection Actions Menu for details.

After configuring an Email connection, you can configure one or more Email activities associated with that connection to be used as a target (to consume data within an operation).

Use the Show dropdown to filter on Endpoints, and then click the Email connection block to display activities that are available to be used with an Email connection:

Activities

For more information, see these activities:

  • Read Email: Retrieves email using the Internet Message Access Protocol (IMAP) and is intended to be used to provide data to an operation.

  • Send Email: Sends email using the Simple Mail Transfer Protocol (SMTP) to specified recipients and is intended to be used as a target in an operation.

  • No labels