Email Receive Connector (Deprecated)

The Email Receive connector supports retrieving messages from an IMAP mail server.

Key Capabilities

IMAP-based email polling with OAuth 2.0 support for modern providers
Advanced filtering with IMAP RFC compliant search filters
Support for downloading full messages or attachments only
Configurable message retention and deletion policies

Overview

The Email Receive connector provides a simple way to automate the process of receiving emails. The connector connects to an IMAP server and polls a specified mailbox for new messages to process. By default the connector only receives messages that have not yet been processed, and it supports additional IMAP filters. The connector supports receiving entire messages in EML format or only downloading attachments on the emails being processed.

OAuth 2.0 configuration for Outlook and Gmail mail servers are the two most common connection configurations made in the Email Receive connector. You can access additional guides and resources for these two mail servers in the CData Community. See Using OAuth 2.0 in the Email Send and Receive Connectors.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Email Receive Configuration

Settings related to establishing the connection.

Setting	Description
Connector Id	The static, unique identifier for the connector.
Connector Type	Displays the connector name and a description of what it does.
Connector Description	An optional field to provide a free-form description of the connector and its role in the flow.

IMAP Connection

Settings related to establishing the connection to the IMAP server.

Setting	Description
Host	The hostname or IP address of the IMAP server.
Port	The port on which to connect to the IMAP server. Typical values include 143 and 993.
Mailbox	The IMAP mailbox to poll for messages.
TLS Type	The method used to negotiate SSL/TLS when connecting to the server: STARTTLS: A plain text connection is established. Afterwards, SSL/TLS can be started with an explicit command. SSL/TLS: Negotiation occurs immediately without first establishing a plain text connection. None (Plain Text): A plain text connection is established, and no SSL/TLS is used.

Authentication

Settings related to authenticating the connection.

Setting	Description
User	The username to login to the IMAP server.
Authentication Mechanism	The type of authentication to use to login to the server. The options vary based on your choice.
Password	(Basic and NTLM) The password to the IMAP server.
Auth URL	(OAuth 2.0) The authorization URL for the service. This is the URL you are directed to when clicking the Connect button to log in and grant permission to the application.
Access Token URL	(OAuth 2.0) The URL to the access token.
Client Id	(OAuth 2.0) The client Id assigned when you registered for OAuth.
Client Secret	(OAuth 2.0) The secret assigned when you registered for OAuth.
Scope	(OAuth 2.0) A list of scopes that the application should have access to.
Callback URL	(OAuth 2.0) The URL where the service you connect to returns tokens to provide access. Services often require you to whitelist the URLs that are allowed, so this is the value to use when configuring the application registration with your service.

Download

Settings related to processing messages.

Setting	Description
New Messages	Check this to only process new messages. This is usually controlled by tracking the UID of downloaded messages. If the UID values become invalid, the connector falls back to using the timestamp of the last processed message or the Days to Search setting if no messages have been processed.
Days to Search	The number of days to search for messages. If Only process new messages is checked, this value is only used if the connector cannot search by UID or the timestamp of the last processed message.
Additional Search Filters	Supply an IMAP RFC compliant search filter to append to the query that is automatically built based on the New Messages and Days to Search settings.
Download Type	Choose to download full messages in EML format or only email attachments.
Delete Emails	Check this to delete successfully downloaded messages from the mailbox.
Expunge After Delete	Check this to permanently delete successfully downloaded emails from the mailbox. Warning: The server might permanently delete (expunge) messages immediately, making them unrecoverable.

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

Setting	Description
Receive	Whether the connector should automatically poll the remote mailbox for messages to download.
Receive Interval	The interval between automatic download attempts.
Minutes Past the Hour	The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc.
Time	The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly.
Day	The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly.
Minutes	The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute.
Cron Expression	A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced.
Start Date and Time	The date and time at which the automation first runs. Every run after that follows the interval setting above. The last and next run times appear in the Automation Status section.

Automation Status

Alerts Tab

SLAs Tab

Advanced Tab

Proxy Settings

These are a collection of settings that identify and authenticate to the proxy through which the connection should be routed. By default, this section uses the global settings on the Proxy Settings portion of the Security Settings page. Clear the checkbox to supply settings specific to your connector.

Setting	Description
Proxy Type	The protocol used by a proxy-based firewall.
Proxy Host	The name or IP address of a proxy-based firewall.
Proxy Port	The TCP port for a proxy-based firewall.
Proxy User	The user name to use to authenticate with a proxy-based firewall.
Proxy Password	A password used to authenticate to a proxy-based firewall.
Authentication Scheme	Leave the default None or choose from one of the following authentication schemes: Basic, Digest, Proprietary, or NTLM.

Advanced Settings

Settings not included in the previous categories.

Setting	Description
IMAP Headers	A comma-delimited list of headers from the IMAP message that should be promoted as metadata in the downloaded file.
Incoming Server Public Certificate	The public key certificate used to verify the identity of a TLS/SSL server. If the target server uses TLS/SSL, set this field to the certificate that identifies the server. If the server’s certificate is not available, you can leave this setting blank to allow the underlying OS/JVM to perform certificate validation, or set it to `Any Certificate` to implicitly trust the server’s identity.
Command Timeout (seconds)	The command execution timeout duration in seconds.
Local File Scheme	A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see Macros.

Message

Message settings determine how the connector searches for messages and manages them after processing.

Note: The settings below are deprecated and hidden by default. They appear only on connectors where they were previously enabled or configured to a non-default value. To retain copies of successfully processed files, right-click the connector in the flow, choose Show Success Path, and connect the success path to a File connector.

Setting	Description
Save to Sent Folder (Deprecated)	Copies files processed by the connector to the Sent folder. Disabled by default. Files saved to the Sent folder are not covered by Encryption at Rest.
Sent Folder Scheme (Deprecated)	Groups files in the Sent folder by the selected time interval. Only relevant when Save to Sent Folder is enabled.

Logging

Setting	Description
Log Level	The verbosity of logs generated by the connector. When you request support, set this to Debug.
Log Subfolder Scheme	Instructs the connector to group files in the Logs folder according to the selected interval. The Weekly option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
Log Messages	Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.

Miscellaneous

Miscellaneous settings are for specific use cases.

Setting	Description
Other Settings	Enables you to configure hidden connector settings in a semicolon-separated list (for example, `setting1=value1;setting2=value2`). Normal connector use cases and functionality should not require the use of these settings.

Establishing a Connection

The following settings are required to establish a network-level connection to the IMAP server:

Host
Port
TLS Type

Use the Test Connection button to verify that the connector can reach the server. Once network-level connectivity has been established, the following settings are required to access the messages stored on the IMAP server:

User
Password or OAuth 2.0 authentication credentials
Mailbox

Receiving Emails

If Receive Automation is enabled, the Email Receive connector automatically polls the configured IMAP mailbox for messages to download. By default, the connector only receives messages it has not already downloaded. The first time the connector receives messages, use the Days to Search setting in the Download configuration section to specify the range of messages to download. Messages can also be manually retrieved by clicking the Receive button on the Output tab of the connector. The Download Type setting determines whether full messages or just message attachments are downloaded. Downloaded files are placed in the Output Folder or passed along to the next connector in the flow. When Download Type is set to Attachments, the connector adds two headers to each message:

EmailReceive-Attachment-Index: The attachment number for each attachment
EmailReceive-Attachment-Count: The total number of attachments on the email

The IMAP Search Filter setting allows for further customization of the range of messages to retrieve. This field accepts standard IMAP protocol filters and only downloads messages that match the configured filters. The following filters are supported:

Filter	Description
`<message set>`	Messages with message sequence numbers corresponding to the specified message sequence number set.
ALL	All messages in the mailbox: this is the default initial key for AND-ing.
ANSWERED	Messages with the `\Answered` flag set.
BCC `<string>`	Messages that contain the specified string in the envelope structure’s BCC field.
BEFORE `<date>`	Messages whose internal date is earlier than the specified date.
BODY `<string>`	Messages that contain the specified string in the body of the message.
CC `<string>`	Messages that contain the specified string in the envelope structure’s CC field.
DELETED	Messages with the `\Deleted` flag set.
DRAFT	Messages with the `\Draft` flag set.
FLAGGED	Messages with the `\Flagged` flag set.
FROM `<string>`	Messages that contain the specified string in the envelope structure’s FROM field.
HEADER `<field-name> <string>`	Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contain the specified string in the [RFC-822] field-body.
KEYWORD `<flag>`	Messages with the specified keyword set.
LARGER `<n>`	Messages with an RFC822.SIZE larger than the specified number of octets.
NEW	Messages that have the `\Recent` flag set but not the `\Seen` flag. This is functionally equivalent to “(RECENT UNSEEN)”.
NOT `<search-key>`	Messages that do not match the specified search key.
OLD	Messages that do not have the `\Recent` flag set. This is functionally equivalent to “NOT RECENT” (as opposed to “NOT NEW”).
ON `<date>`	Messages whose internal date is within the specified date.
OR `<search-key1> <search-key2>`	Messages that match either search key.
RECENT	Messages that have the `\Recent` flag set.
SEEN	Messages that have the `\Seen` flag set.
SENTBEFORE `<date>`	Messages whose [RFC-822] Date: header is earlier than the specified date.
SENTON `<date>`	Messages whose [RFC-822] Date: header is within the specified date.
SENTSINCE `<date>`	Messages whose [RFC-822] Date: header is within or later than the specified date.
SINCE `<date>`	Messages whose internal date is within or later than the specified date.
SMALLER `<n>`	Messages with an RFC822.SIZE smaller than the specified number of octets.
SUBJECT `<string>`	Messages that contain the specified string in the envelope structure’s SUBJECT field.
TEXT `<string>`	Messages that contain the specified string in the header or body of the message.
TO `<string>`	Messages that contain the specified string in the envelope structure’s TO field.
UID `<message set>`	Messages with unique identifiers corresponding to the specified unique identifier set.
UNANSWERED	Messages that do not have the `\Answered` flag set.
UNDELETED	Messages that do not have the `\Deleted` flag set.
UNDRAFT	Messages that do not have the `\Draft` flag set.
UNFLAGGED	Messages that do not have the `\Flagged` flag set.
UNKEYWORD `<flag>`	Messages that do not have the specified keyword set.
UNSEEN	Messages that do not have the `\Seen` flag set.

Getting Started

Flows

EDI Trading Partner Management Console

Connectors

Mapping

APIs and Automation

How-To Guides

Scripting

Software License and Third-Party Copyrights

Key Capabilities

Overview

Connector Configuration

Settings Tab

Email Receive Configuration

IMAP Connection

Authentication

Download

Automation Tab

Automation Settings

Automation Status

Alerts Tab

SLAs Tab

Advanced Tab

Proxy Settings

Advanced Settings

Message

Logging

Miscellaneous

Establishing a Connection

Receiving Emails

Search Filters

Macros

Examples

​Key Capabilities

​Overview

​Connector Configuration

​Settings Tab

​Email Receive Configuration

​IMAP Connection

​Authentication

​Download

​Automation Tab

​Automation Settings

​Automation Status

​Alerts Tab

​SLAs Tab

​Advanced Tab

​Proxy Settings

​Advanced Settings

​Message

​Logging

​Miscellaneous

​Establishing a Connection

​Receiving Emails

​Search Filters

​Macros

​Examples

Key Capabilities

Overview

Connector Configuration

Settings Tab

Email Receive Configuration

IMAP Connection

Authentication

Download

Automation Tab

Automation Settings

Automation Status

Alerts Tab

SLAs Tab

Advanced Tab

Proxy Settings

Advanced Settings

Message

Logging

Miscellaneous

Establishing a Connection

Receiving Emails

Search Filters

Macros

Examples