Skip to main content

Email connectors

The email connectors include input and output connectors:

  • The Watched Mailbox connectors convert all emails that are placed into a configurable mailbox. After the conversion is finished, the mails are deleted.
  • The Output Mailbox connectors copy the files to a configurable mailbox.
  • The Send Email connectors are used to send an email to a configurable recipient.

Watched Mailbox (IMAP)​

The Watched Mailbox (IMAP) connector converts all emails that are placed into a configurable mailbox on an IMAP server. After the conversion is finished, the mails are deleted.

Settings​

  • Host/Port: Host name and port of the IMAP server.
  • SSL: Type of encryption for connecting with the IMAP server.
  • Username and Password: Credentials for authenticating with the mail account.
  • Mailbox Path: Path where all incoming message are to be converted.
  • Attachments only: Turn on to process attached files only, and not the entire email body.

Variables​

The following variables are set by this input connector:

  • From: The sender of the email, including the display name if available.
    Examples:
    • John Doe <john.doe@example.com>
    • john.doe@example.com
  • Subject: The subject of the email.

Watched Mailbox (Exchange Online)​

This connector converts all emails that are placed into a configurable mailbox on an Microsoft Exchange Online server. After the conversion is finished, the mails are deleted.

When selecting a mailbox, the connector asks for access to the emails on the specified account. The user must consent to this, otherwise the connector does not work.

Settings​

  • Username: Credentials to authenticate with the server.
  • Mailbox Path: Path where all incoming message are to be converted.
  • Attachments only: Turn on to process attached files only, and not the entire email body.

Variables​

The following variables are set by this input connector:

  • From: The sender of the email, including the display name if available. Examples:
    • John Doe <john.doe@example.com>
    • john.doe@example.com
  • Subject: The subject of the email.

Output Mailbox (IMAP)​

This connector copies files to a configurable mailbox on an IMAP server. In the case that the files are the original files coming from a Watched Mailbox input connector, the original email is copied as is. In all other cases, a new empty email is created with the files as attachment.

Settings​

  • Job Status: Each output connector can only be active for a subset of result statuses:
    • Success: The connector is active for all jobs that completed successfully without warnings
    • Warnings: The connector is active for all jobs that completed successfully with warnings
    • Success or Warnings: The connector is active for all jobs that completed successfully with or without warnings
    • Error: The connector is active for all jobs that failed
  • Account Settings: Configure the IMAP server account.
    • Host/Port: Host name and port of the IMAP server.
    • SSL: Type of encryption for connecting with the IMAP server.
    • Username and Password: Credentials for authenticating with the mail account.
  • Mailbox Path: Path where all incoming message are to be converted.
  • File Set: The files to be copied to the output mailbox. You can either copy the unprocessed input files (originals) or copy the resulting files from the workflow to the output folder.
  • Preserve Input Mail Body: Enable this option to copy the original mail body. Otherwise, a new empty email is created with the files as an attachment.

Output Mailbox (Exchange Online)​

This connector copies files to a configurable mailbox on a Microsoft Exchange Online server. In the case that the files are the original files coming from a Watched Mailbox Exchange Online input connector, the original email is copied as is. In all other cases, a new empty email is created with the files as attachment.

Settings​

  • Job Status: Each output connector can only be active for a subset of result statuses:
    • Success: The connector is active for all jobs that completed successfully without warnings
    • Warnings: The connector is active for all jobs that completed successfully with warnings
    • Success or Warnings: The connector is active for all jobs that completed successfully with or without warnings
    • Error: The connector is active for all jobs that failed
  • Username: Credentials to authenticate with the server.
  • Mailbox Path: Path where all incoming message are to be converted.
  • File Set: The files to be copied to the output mailbox. You can either copy the unprocessed input files (originals) or copy the resulting files from the workflow to the output folder.
  • Preserve Input Mail Body: Enable this option to copy the original mail body. Otherwise, a new empty email is created with the files as an attachment.

Send Email (SMTP)​

This connector sends an email to a configurable recipient. Email properties such as TO, CC, BCC, subject, and body text can be configured freely and may contain variable placeholders to include dynamic data.

For example:

  • Information about the processing such as error message, warnings or events.
  • Variables set in the request of the REST Input connector.
  • Query parameters from the REST Input connector.

The email can be configured to contain either the results or the original files as attachments.

Settings​

  • Job Status: Each output connector can only be active for a subset of result statuses:
    • Success: The connector is active for all jobs that completed successfully without warnings
    • Warnings: The connector is active for all jobs that completed successfully with warnings
    • Success or Warnings: The connector is active for all jobs that completed successfully with or without warnings
    • Error: The connector is active for all jobs that failed
  • Account Settings: Configure the SMTP server account.
    • Host/Port: Host name and port of the SMTP server.
    • SSL: Type of encryption for connecting with the IMAP server.
    • Username and Password: Credentials for authenticating with the mail account. Click Validate to test that the Conversion Service can connect to the mail server.
  • Message: Configure the message to be sent.
    • To / CC / BB: You can customize the recipients. Only one primary recipient can be configured per field.
      The email address may contain a display name in the form Display Name <address>. The address may contain placeholder variables coming from the input connector.
    • Subject: The subject may contain placeholder variables coming from the input connector.
    • Body: The body may contain placeholder values. The body is sent as plain text, HTML content is not supported.
  • Attachments: The files to be included in the email. You can choose unprocessed input files (originals), copy the resulting files from the workflow to the output folder, or not include any attachments.

Send Email (Exchange Online)​

This connector sends an email to a configurable recipient by using a Microsoft Exchange Online account. Email properties such as TO, CC, BCC, subject, and body text can be configured freely and may contain variable placeholders to include dynamic data.

For example:

  • Information about the processing such as error message, warnings or events.
  • Variables set in the request of the REST Input connector.
  • Query parameters from the REST Input connector

The email can be configured to contain either the results or the original files as attachments.

Settings​

  • Job Status: Each output connector can only be active for a subset of result statuses:
    • Success: The connector is active for all jobs that completed successfully without warnings
    • Warnings: The connector is active for all jobs that completed successfully with warnings
    • Success or Warnings: The connector is active for all jobs that completed successfully with or without warnings
    • Error: The connector is active for all jobs that failed
  • Username: Credentials to authenticate with the server. Click Validate to test that the Conversion Service can connect to the mail server.
  • Message: Message to be included in the send mail.
    • To / CC / BB: You can customize the recipients. Only one primary recipient can be configured per field.
      The email address may contain a display name in the form Display Name <address>. The address may contain placeholder variables coming from the input connector.
    • Subject: The subject may contain placeholder variables coming from the input connector.
    • Body: The body may contain placeholder values. The body is sent as plain text, HTML content is not supported.
  • Attachments: The files to be included in the email. You can choose unprocessed input files (originals), copy the resulting files from the workflow to the output folder, or not include any attachments.

Placeholders in Send Email connectors​

You can use placeholders in the recipient, subject, and body fields of the Send Email (Exchange Online) and Send Email (SMTP) connectors.

Recipient variables​

If a watched mailbox is used as input connector, the placeholder [input:From] can be used to refer to the sender of the original email.

Subject variables​

If a watched mailbox is used as input connector, the placeholder [input:Subject] can be used to refer to the subject of the original email. For example, Re: [input:Subject]

Body variables​

  • [output:ERROR]: The error message. This placeholder is only available in case of an error.
  • [output:WARNINGS]: A list of warnings that happened during processing. One warning per line.
  • [output:EVENTS]: A list of everything that happened during processing. One event per line including the severity.
  • [input:‹variable name›]: A custom variable set by the input connector.