Email Connector Reference 1.6 - Mule 4

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection types for this configuration

x

Enumeration, one of:

Enables you to specify a strategy for how to name attachments

NAME

Boolean

Indicates whether to open and read the retrieved emails. The default value is "true".

true

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances when as appropriate.

Object

An additional set of custom properties to configure the connection session

Enumeration, one of:

A Time Unit that qualifies the connectionTimeout, writeTimeout and readTimeout attributes

SECONDS

Number

The socket connection timeout value. This attribute works in tandem with timeoutUnit.

5

Number

The socket read timeout value. This attribute works in tandem with timeoutUnit.

5

Number

The socket write timeout value. This attribute works in tandem with timeoutUnit.

5

String

Host name of the mail server.

x

String

Username used to connect with the mail server.

String

Username password to connect with the mail server.

String

The port number of the mail server.

993

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Pooling Profile

Characteristics of the connection pool

Object

An additional set of custom properties to configure the connection session.

Enumeration, one of:

A time unit that qualifies the connectionTimeout, writeTimeout and readTimeout attributes.

SECONDS

Number

The socket connection timeout value. This attribute works in tandem with timeoutUnit.

5

Number

The socket read timeout value. This attribute works in tandem with #timeoutUnit.

5

Number

The socket write timeout value. This attribute works in tandem with #timeoutUnit

5

String

Host name of the mail server

x

String

Username used to connect with the mail server

String

Username password to connect with the mail server

String

The port number of the mail server

993

TlS

TLS Configuration for the secure connection of the IMAPS protocol

x

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Pooling Profile

Characteristics of the connection pool

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection types for this configuration

x

Enumeration, one of:

Enables you to specify a strategy for how to name attachments

NAME

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances when appropriate.

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection types for this configuration.

x

String

The "From" address of the message sender

String

Default character encoding to use in all the messages. If not specified, the default charset in the Mule configuration is used.

String

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances when appropriate.

String

Name of the configuration to use.

x

String

Mailbox folder from which to delete the emails

INBOX

Number

Email ID number of the email to delete

x

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use.

x

String

Mailbox folder where the emails with the DELETED flag are scheduled to be permanently deleted

INBOX

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use..

x

String

Mailbox folder from which to fetch the emails

INBOX

IMAP Matcher

Email Matcher that gives the capability of filtering the retrieved emails

Boolean

Specifies whether to delete the returned emails after they are retrieved

false

Number

Size of the page used by the Paging Provider implementation for fetching the emails from the IMAP server

10

Number

Maximum number of emails retrieved by the operation. Take into account that this limit applies only to the emails effectively retrieved by the operation (the emails that match the IMAPEmailPredicateBuilder criteria) and doesn’t imply any restrictions for the amount of emails that are retrieved from the mailbox server.

-1

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Enumeration, one of:

Enables you to specify a strategy for how to name attachments

NAME

String

The name of a variable to store the operation’s output

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable

#[payload]

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use..

x

String

Mailbox folder where the emails are going to be marked as deleted

INBOX

Number

Email ID number of the email to mark as deleted.

x

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use..

x

String

Folder where the emails are going to be marked as read

INBOX

Number

Email ID number of the email to mark as read.

x

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use.

x

String

Source mailbox folder where emails to move are located.

INBOX

String

Target mailbox folder where emails are moved.

x

Number

Email ID number of the email to move.

x

Boolean

Creates the target folder if the folder does not exist.

false

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use..

x

String

Mailbox folder from which to fetch the emails

INBOX

POP3 Matcher

Email Matcher that gives the capability of filtering the retrieved emails

Boolean

Specifies whether to delete the returned emails after they are retrieved

false

Number

Size of the page used by the Paging Provider implementation for fetching the emails from the POP3 server

10

Number

Maximum number of emails retrieved by the operation. Take into account that this limit applies only to the emails effectively retrieved by the operation (the emails that matched the IMAPEmailPredicateBuilder criteria) and doesn’t imply any restriction over the number of emails that are retrieved from the mailbox server.

-1

Configure to use repeatable streams.

Enumeration, one of:

Enables you to specify a strategy for how to name attachments

NAME

String

The name of a variable to store the operation’s output.

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable

#[payload]

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use.

x

String

The "From" address of the message sender. If not set, it defaults to the "From" address specified in the config.

Array of String

The recipient addresses of "To" (primary) type

x

Array of String

The recipient addresses of "CC" (carbon copy) type

Array of String

The recipient addresses of "BCC" (blind carbon copy) type

Array of String

The email addresses to which to reply to this email

String

The subject of the email

Object

The headers that this email carries

Binary

Text body of the message, which can be in any format

#[payload]

String

Content Type of the body text. Example: "text/plain"

String

The character encoding of the body. If it is configured, it overrides the one inferred from the body.

Object

The attachments that are sent along with the email body

String

Encoding used to indicate the type of transformation that is used to represent the body in an acceptable manner for transport. The value is case insensitive. Known encodings: BASE64, QUOTED-PRINTABLE, 8BIT, 7BIT, BINARY

Base64

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use..

x

String

The name of the folder to poll emails from.

INBOX

Boolean

Specifies whether to delete the returned emails after they are retrieved

false

Boolean

Specifies wether to apply watermark to the polled emails.

true

IMAP Matcher

A matcher to filter emails retrieved by this polling source. By default, already-read emails will be filtered.

Boolean

If search filters should be resolved on the server side, set this value to true. The default is false, which means search filters are resolved on the client side. This is because some email servers are not fully compliant with rfc-3501 search terms. Activating this feature diminishes traffic by reducing the number of emails sent to the client side for processing.

false

Boolean

Whether to execute this source on the primary node only when running in cluster mode

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Enumeration, one of:

Enables you to specify a strategy for how to name attachments

NAME

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

String

Name of the configuration to use.

x

String

The name of the folder to poll emails from

INBOX

Boolean

Specifies whether to delete the returned emails after they are retrieved

false

POP3 Matcher

A matcher to filter emails retrieved by this polling source

Boolean

Whether to execute this source on the primary node only when running in cluster mode

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Enumeration, one of:

Enables you to specify a strategy for how to name attachments

NAME

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.