Contact Us 1-800-596-4880
  1. Homepage
  2. Email Connector (1.8)

  3. Email Connector Reference

All Connectors

Email Connector Reference 1.8

Support Category: Select

Anypoint Connector for Email (Email Connector ) is used to list and send emails and perform operations in different mailboxes, such as delete and mark as read.

Email Connector supports the SMTP, SMTPS, IMAP, IMAPS, POP3, and POP3s protocols.

Configurations

IMAP

Configuration for operations that are performed through the IMAP (Internet Message Access Protocol) protocol.

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Indicates how attachment names should be retrieved.

NAME

Eagerly Fetch Content

Boolean

Indicates whether the retrieved emails should be opened and read. The default value is "true".

true

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

IMAP Connection

A ConnectionProvider that returns instances of imap based MailboxConnections.

Parameters
Name Type Description Default Value Required

Properties

Object

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

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #connectionTimeout, #writeTimeout and #readTimeout attributes. Defaults to SECONDS

SECONDS

Connection Timeout

Number

The socket connection timeout value. This attribute works in tandem with #timeoutUnit. Defaults to 5

5

Read Timeout

Number

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

5

Write Timeout

Number

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

5

Host

String

Host name of the mail server.

x

User

String

Username used to connect with the mail server.

Password

String

Username password to connect with the mail server.

Port

String

The port number of the mail server. '993' by default.

993

Reconnection

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

Pooling Profile

Characteristics of the connection pool
IMAPS Connection

A ConnectionProvider that returns instances of imaps (secure) based MailboxConnections. The returned connection is secured by TLS.

Parameters
Name Type Description Default Value Required

Properties

Object

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

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #connectionTimeout, #writeTimeout and #readTimeout attributes. Defaults to SECONDS

SECONDS

Connection Timeout

Number

The socket connection timeout value. This attribute works in tandem with #timeoutUnit. Defaults to 5

5

Read Timeout

Number

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

5

Write Timeout

Number

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

5

Host

String

Host name of the mail server.

x

User

String

Username used to connect with the mail server.

Password

String

Username password to connect with the mail server.

Port

String

The port number of the mail server. '993' by default.

993

TLS Configuration

TLS

TLS Configuration for the secure connection of the IMAPS protocol

x

Reconnection

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

Pooling Profile

Characteristics of the connection pool

Supported Operations

Associated Sources

POP3

Configuration for operations that are performed through the POP3 (Post Office Protocol 3) protocol.

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Indicates how attachment names should be retrieved.

NAME

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

POP3 Connection

A ConnectionProvider that returns instances of pop3 based MailboxConnections.

Parameters
Name Type Description Default Value Required

Properties

Object

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

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #connectionTimeout, #writeTimeout and #readTimeout attributes. Defaults to SECONDS

SECONDS

Connection Timeout

Number

The socket connection timeout value. This attribute works in tandem with #timeoutUnit. Defaults to 5

5

Read Timeout

Number

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

5

Write Timeout

Number

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

5

Host

String

Host name of the mail server.

x

User

String

Username used to connect with the mail server.

Password

String

Username password to connect with the mail server.

Port

String

The port number of the mail server. '110' by default.

110

Reconnection

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

Pooling Profile

Characteristics of the connection pool
POP3S Connection

A ConnectionProvider that returns instances of pop3s (secured) based MailboxConnections. The returned connection is secured by TLS.

Parameters
Name Type Description Default Value Required

Properties

Object

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

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #connectionTimeout, #writeTimeout and #readTimeout attributes. Defaults to SECONDS

SECONDS

Connection Timeout

Number

The socket connection timeout value. This attribute works in tandem with #timeoutUnit. Defaults to 5

5

Read Timeout

Number

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

5

Write Timeout

Number

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

5

Host

String

Host name of the mail server.

x

User

String

Username used to connect with the mail server.

Password

String

Username password to connect with the mail server.

Port

String

The port number of the mail server. '995' by default.

995

TLS Configuration

TLS

TLS Configuration for the secure connection of the POP3S protocol

x

Reconnection

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

Pooling Profile

Characteristics of the connection pool

Supported Operations

Associated Sources

SMTP

Configuration for operations that are performed through the SMTP (Simple Mail Transfer Protocol) protocol.

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

From

String

The "From" sender address. The person that is going to send the messages.

Default Encoding

String

Default character encoding to use in all the messages. If not specified, the default charset in the mule configuration will be used

Default Content Transfer Encoding

String

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

SMTP Connection

A ConnectionProvider that returns instances of smtp based SenderConnections.

Parameters
Name Type Description Default Value Required

Properties

Object

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

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #connectionTimeout, #writeTimeout and #readTimeout attributes. Defaults to SECONDS

SECONDS

Connection Timeout

Number

The socket connection timeout value. This attribute works in tandem with #timeoutUnit. Defaults to 5

5

Read Timeout

Number

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

5

Write Timeout

Number

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

5

Host

String

Host name of the mail server.

x

User

String

Username used to connect with the mail server.

Password

String

Username password to connect with the mail server.

Port

String

The port number of the mail server. '25' by default.

25

Reconnection

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

Pooling Profile

Characteristics of the connection pool
SMTPS Connection

A ConnectionProvider that returns instances of smtps based MailboxConnections. The returned connection is secured by TLS.

Parameters
Name Type Description Default Value Required

Properties

Object

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

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #connectionTimeout, #writeTimeout and #readTimeout attributes. Defaults to SECONDS

SECONDS

Connection Timeout

Number

The socket connection timeout value. This attribute works in tandem with #timeoutUnit. Defaults to 5

5

Read Timeout

Number

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

5

Write Timeout

Number

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

5

Host

String

Host name of the mail server.

x

User

String

Username used to connect with the mail server.

Password

String

Username password to connect with the mail server.

Port

String

The port number of the mail server. '465' by default.

465

TLS Configuration

TLS

TLS Configuration for the secure connection of the SMTPS protocol

x

Reconnection

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

Pooling Profile

Characteristics of the connection pool

Supported Operations

Operations

Count messages - IMAP

<email:count-messages-imap>

Counts the emails in the mailboxFolder.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Mailbox Folder

String

Mailbox folder where the emails are.

INBOX

Count Filter

Enumeration, one of:

  • ALL

  • DELETED

  • NEW

  • UNREAD

Count only messages specified with this option.

ALL

Target Variable

String

Name of the variable that storesoperation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • EMAIL:EMAIL_COUNT_MESSAGES

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

Delete

<email:delete>

Eliminates from the mailbox the email with ID emailId. For IMAP mailboxes all the messages scheduled for deletion (marked as DELETED) will also be erased from the folder.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Mailbox Folder

String

Mailbox folder where the emails are going to delete

INBOX

Email ID

Number

Email ID Number of the email to delete.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • EMAIL:EMAIL_NOT_FOUND

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

Expunge Folder

<email:expunge-folder>

Eliminates from the mailbox all the messages scheduled for deletion with the DELETED flag set.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Mailbox Folder

String

Mailbox folder where the emails with the 'DELETED' flag are going to be scheduled to be definitely deleted

INBOX

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

List - IMAP

<email:list-imap>

List all the emails (with pagination) in the configured imap mailBoxFolder that match with the specified imapMatcher criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Mailbox Folder

String

Mailbox folder where the emails are going to be fetched

INBOX

Match with

Imap Matcher

Email Matcher which gives the capability of filter the retrieved emails

Delete After Retrieve

Boolean

Specifies if the returned emails must be deleted after being retrieved or not.

false

Page Size

Number

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

10

Pagination Offset

Number

Size of the pagination offset used by the PagingProvider implementation for fetching the emails from the IMAP server

0

Limit

Number

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

-1

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Indicates how attachment names should be retrieved.

Target Variable

String

Name of the variable that storesoperation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Message of [Stored Email Content] payload and [IMAP Email Attributes] attributes

For Configurations

Throws

  • EMAIL:EMAIL_LIST

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

Mark As Deleted

<email:mark-as-deleted>

Marks an incoming email as DELETED, this way the marked email(s) are scheduled for deletion when the folder closes, this means that the email is not physically eliminated from the mailbox folder, but it’s state changes. All DELETED marked emails are going to be eliminated from the mailbox when one of IMAPOperations#expungeFolder(MailboxConnection, String) or IMAPOperations#delete(MailboxConnection, String, long) is executed. This operation targets a single email.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Mailbox Folder

String

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

INBOX

Email ID

Number

Email ID Number of the email to mark as deleted.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • EMAIL:EMAIL_NOT_FOUND

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

Mark As Read

<email:mark-as-read>

Marks a single email as READ changing it’s state in the specified mailbox folder. This operation can targets a single email.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Mailbox Folder

String

Folder where the emails are going to be marked as read

INBOX

Email ID

Number

Email ID Number of the email to mark as read.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • EMAIL:EMAIL_NOT_FOUND

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

Move To Folder

<email:move-to-folder>

Moves the email with ID emailId from the sourceFolder to the targetFolder.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Source Folder

String

Mailbox folder where the emails to be moved are located.

INBOX

Target Folder

String

Mailbox folder where the emails will be moved.

x

Email ID

Number

Email ID Number of the email to move.

x

Create Target Folder

Boolean

Create the target folder if it does not exist.

false

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • EMAIL:EMAIL_NOT_FOUND

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

Count messages - POP3

<email:count-messages-pop3>

Counts the emails in the INBOX_FOLDER.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Target Variable

String

Name of the variable that storesoperation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • EMAIL:EMAIL_COUNT_MESSAGES

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

List - POP3

<email:list-pop3>

List all the emails (with pagination) in the configured pop3 mailBoxFolder that match with the specified pop3Matcher criteria. As the POP3 protocol does not support the capability to find specific emails from its UID in a folder to move/delete it. a parameter deleteAfterRetrieve is available for deleting the emails from the server right after being retrieved.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Mailbox Folder

String

Mailbox folder where the emails are going to be fetched

INBOX

Match with

Pop3 Matcher

Email Matcher which gives the capability of filter the retrieved emails

Delete After Retrieve

Boolean

Specifies if the returned emails must be deleted after being retrieved or not.

false

Page Size

Number

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

10

Pagination Offset

Number

Size of the pagination offset used by the PagingProvider implementation for fetching the emails from the POP3 server

0

Limit

Number

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

-1

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Indicates how attachment names should be retrieved.

Target Variable

String

Name of the variable that storesoperation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Message of [Stored Email Content] payload and [POP3 Email Attributes] attributes

For Configurations

Throws

  • EMAIL:EMAIL_LIST

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

Send

<email:send>

Sends an email message. The message is sent to all recipient toAddresses, ccAddresses, bccAddresses specified in the message. The content of the message aims to be some type of text (text/plan, text/html) and its composed by the body and it’s content type. If no content is specified then the incoming payload it’s going to be converted into plain text if possible.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

From Address

String

The "From" sender address. The person that is going to send the messages, if not set, it defaults to the from address specified in the config.

To Addresses

Array of String

The recipient addresses of "To" (primary) type.

x

Cc Addresses

Array of String

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

Bcc Addresses

Array of String

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

Reply To Addresses

Array of String

The email addresses to which this email should be replied.

Subject

String

The subject of the email.

Headers

Object

The headers that this email carry.

Content

Binary

Text body of the message. Aims to be text in any format

#[payload]

ContentType

String

ContentType of the body text. Example: "text/plain".

Encoding

String

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

Content Transfer Encoding

String

Encoding used to indicate the type of transformation that has been 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

Attachments

Object

The attachments for an Email, that is sent along the email body.

Content Transfer Encoding

String

Encoding used to indicate the type of transformation that has been 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

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • EMAIL:SEND

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

Sources

On New Email - IMAP

<email:listener-imap>

Retrieves all the emails from an IMAP mailbox folder, watermark can be enabled for polled items.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Folder

String

The name of the folder to poll emails from. Defaults to "INBOX".

INBOX

Delete After Retrieve

Boolean

Enables the deletion of the polled emails after being retrieved. This is disabled by default.

false

Enable Watermark

Boolean

If watermark should be applied to the polled emails or not. Default to true.

true

Imap Matcher

Imap Matcher

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

Enable Remote Search

Boolean

If search filters should be resolved on server(true) or client(false) side. Default to false because some email servers might not be fully compliant with rfc-3501’s search terms. Activating this feature will diminish traffic by reducing the amount of emails brought to client side for processing.

false

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

[RedeliveryPolicy]

Defines a policy for processing the redelivery of the same message.

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Indicates how attachment names should be retrieved.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Stored Email Content

Attributes Type

Base Email Attributes

For Configurations

On New Email - POP3

<email:listener-pop3>

Retrieves all the emails from an POP3 mailbox folder.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Folder

String

The name of the folder to poll emails from. Defaults to "INBOX".

INBOX

Delete After Retrieve

Boolean

Enables the deletion of the polled emails after being retrieved. This is disabled by default.

false

Pop3 Matcher

Pop3 Matcher

A matcher to filter emails retrieved by this polling source.

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

[RedeliveryPolicy]

Defines a policy for processing the redelivery of the same message.

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Indicates how attachment names should be retrieved.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Stored Email Content

Attributes Type

Base Email Attributes

For Configurations

Types

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

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.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)

Disabled

Boolean

Whether pooling should be disabled

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of store.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of store.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Stored Email Content

Field Type Description Default Value Required

Body

String

x

Attachments

Any

x

Base Email Attributes

Field Type Description Default Value Required

Number

Number

x

From Addresses

Array of String

x

To Addresses

Array of String

x

Cc Addresses

Array of String

x

Bcc Addresses

Array of String

x

Reply To Addresses

Array of String

x

Headers

Object

Map of HTTP headers in the message.

x

Subject

String

x

Received Date

DateTime

Sent Date

DateTime

Imap Matcher

Field Type Description Default Value Required

Seen

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

Indicates if should retrieve 'seen' or 'not seen' emails

INCLUDE

Answered

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

Indicates if should retrieve 'answered' or 'not answered' emails

INCLUDE

Deleted

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

Indicates if should retrieve 'marked as deleted' or 'not marked as deleted' emails

INCLUDE

Recent

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

"Indicates if should retrieve 'recent' or 'not recent' emails

INCLUDE

Received Since

DateTime

Indicates since which date the received emails must be retrieved

Received Until

DateTime

Indicates until which date the received emails must be retrieved

Sent Since

DateTime

Indicates since which date the sent emails must be retrieved

Sent Until

DateTime

Indicates until which date the sent emails must be retrieved

Subject Regex

String

Subject Regex to match with the wanted emails

From Regex

String

From Email Address Regex to match with the wanted emails

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Object Store

Object Store

Configures the object store that stores the redelivery counter for each message.

IMAP Email Attributes

Field Type Description Default Value Required

Flags

Email Flags

x

Id

String

x

Number

Number

x

From Addresses

Array of String

x

To Addresses

Array of String

x

Cc Addresses

Array of String

x

Bcc Addresses

Array of String

x

Reply To Addresses

Array of String

x

Headers

Object

Map of HTTP headers in the message.

x

Subject

String

x

Received Date

DateTime

Sent Date

DateTime

Email Flags

Field Type Description Default Value Required

Answered

Boolean

false

Deleted

Boolean

false

Draft

Boolean

false

Recent

Boolean

false

Seen

Boolean

false

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Pop3 Matcher

Field Type Description Default Value Required

Received Since

DateTime

Indicates since which date the received emails must be retrieved

Received Until

DateTime

Indicates until which date the received emails must be retrieved

Sent Since

DateTime

Indicates since which date the sent emails must be retrieved

Sent Until

DateTime

Indicates until which date the sent emails must be retrieved

Subject Regex

String

Subject Regex to match with the wanted emails

From Regex

String

From Email Address Regex to match with the wanted emails

POP3 Email Attributes

Field Type Description Default Value Required

Id

String

x

Number

Number

x

From Addresses

Array of String

x

To Addresses

Array of String

x

Cc Addresses

Array of String

x

Bcc Addresses

Array of String

x

Reply To Addresses

Array of String

x

Headers

Object

Map of HTTP headers in the message.

x

Subject

String

x

Received Date

DateTime

Sent Date

DateTime
Back to top
View on GitHub