Email Module Documentation Reference

Email connector used to list and send emails and perform operations in different mailboxes, such as delete and mark as read.

This 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	The name for this configuration. Connectors reference the configuration with this name.		x
Connection	IMAP Connection IMAPS Connection	The connection types that can be provided to this configuration.		x
Eagerly Fetch Content	Boolean	Indicates whether the retrieved emails should be opened and read. The default value is "true".	true

Name

Type

Description

Default Value

Required

Name

String

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

Connection

IMAP Connection
IMAPS Connection

The connection types that can be provided to this configuration.

Eagerly Fetch Content

Boolean

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

true

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 will fail if the test doesn't pass after exhausting the associated reconnection strategy
Pooling Profile	Pooling Profile	Characteristics of the connection pool

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

Read Timeout

Number

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

Defaults to 5

Write Timeout

Number

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

Defaults to 5

Host

String

Host name of the mail server.

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

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

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	A factory for TLS contexts. A TLS context is configured with a key store and a trust store. Allows to create a TLS secured connections.		x
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy
Pooling Profile	Pooling Profile	Characteristics of the connection pool

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

Read Timeout

Number

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

Defaults to 5

Write Timeout

Number

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

Defaults to 5

Host

String

Host name of the mail server.

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

A factory for TLS contexts. A TLS context is configured with a key store and a trust store. Allows to create a TLS secured connections.

Reconnection

Pooling Profile

Characteristics of the connection pool

POP3

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

Parameters

Name	Type	Description	Default Value	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.		x
Connection	POP3 Connection POP3S Connection	The connection types that can be provided to this configuration.		x

Name

Type

Description

Default Value

Required

Name

String

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

Connection

POP3 Connection
POP3S Connection

The connection types that can be provided to this configuration.

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 will fail if the test doesn't pass after exhausting the associated reconnection strategy
Pooling Profile	Pooling Profile	Characteristics of the connection pool

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

Read Timeout

Number

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

Defaults to 5

Write Timeout

Number

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

Defaults to 5

Host

String

Host name of the mail server.

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

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	A factory for TLS contexts. A TLS context is configured with a key store and a trust store. Allows to create a TLS secured connections.		x
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy
Pooling Profile	Pooling Profile	Characteristics of the connection pool

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

Read Timeout

Number

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

Defaults to 5

Write Timeout

Number

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

Defaults to 5

Host

String

Host name of the mail server.

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

A factory for TLS contexts. A TLS context is configured with a key store and a trust store. Allows to create a TLS secured connections.

Reconnection

Pooling Profile

Characteristics of the connection pool

Associated Operations

List - POP3

SMTP

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

Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	SMTP Connection SMTPS Connection	The connection types that can be provided 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 be used in all the messages. If not specified, the default charset in the mule configuration will be used
Default Content Transfer Encoding	String

Name

Type

Description

Default Value

Required

Name

String

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

Connection

SMTP Connection
SMTPS Connection

The connection types that can be provided to this configuration.

From

String

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

Default Encoding

String

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

Default Content Transfer Encoding

String

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 will fail if the test doesn't pass after exhausting the associated reconnection strategy
Pooling Profile	Pooling Profile	Characteristics of the connection pool

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

Read Timeout

Number

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

Defaults to 5

Write Timeout

Number

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

Defaults to 5

Host

String

Host name of the mail server.

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.

Reconnection

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	A factory for TLS contexts. A TLS context is configured with a key store and a trust store. Allows to create a TLS secured connections.		x
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy
Pooling Profile	Pooling Profile	Characteristics of the connection pool

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

Read Timeout

Number

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

Defaults to 5

Write Timeout

Number

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

Defaults to 5

Host

String

Host name of the mail server.

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

A factory for TLS contexts. A TLS context is configured with a key store and a trust store. Allows to create a TLS secured connections.

Reconnection

Pooling Profile

Characteristics of the connection pool

Associated Operations

Send

Operations

Delete

http://www.mulesoft.org/schema/mule/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	The name of the configuration to use.		x
Mailbox Folder	String	Mailbox folder where the emails are going to be deleted	INBOX
Email ID	Number	Email ID Number of the email to delete.		x
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Mailbox Folder

String

Mailbox folder where the emails are going to be deleted

INBOX

Email ID

Number

Email ID Number of the email to delete.

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

For Configurations.

IMAP

Throws

EMAIL:RETRY_EXHAUSTED
EMAIL:CONNECTIVITY
EMAIL:EMAIL_NOT_FOUND
EMAIL:ACCESSING_FOLDER

Expunge Folder

http://www.mulesoft.org/schema/mule/email:expunge-folder

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

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The 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	INBOX
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Mailbox Folder

String

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

INBOX

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

For Configurations.

IMAP

Throws

EMAIL:RETRY_EXHAUSTED
EMAIL:CONNECTIVITY
EMAIL:ACCESSING_FOLDER

List - IMAP

http://www.mulesoft.org/schema/mule/email:list-imap

List all the emails (with pagination) in the configured imap mailBoxFolder that match with the specified imapMatcher criteria. 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.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The 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
Limit	Number	Maximum amount of emails retrieved by the operation. Take into account that this limit only applies to the emails effectively	-1
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable [non-repeatable-iterable]	Configure if repeatable streams should be used and their behaviour
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

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

Limit

Number

Maximum amount of emails retrieved by the operation. Take into account that this limit only applies to the emails effectively

-1

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
[non-repeatable-iterable]

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

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

For Configurations.

IMAP

Mark As Deleted

http://www.mulesoft.org/schema/mule/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	The 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

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.

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

For Configurations.

IMAP

Throws

EMAIL:RETRY_EXHAUSTED
EMAIL:CONNECTIVITY
EMAIL:EMAIL_NOT_FOUND
EMAIL:ACCESSING_FOLDER

Mark As Read

http://www.mulesoft.org/schema/mule/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	The 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

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.

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

For Configurations.

IMAP

Throws

EMAIL:RETRY_EXHAUSTED
EMAIL:CONNECTIVITY
EMAIL:EMAIL_NOT_FOUND
EMAIL:ACCESSING_FOLDER

List - POP3

http://www.mulesoft.org/schema/mule/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. 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.

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The 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
Limit	Number	Maximum amount of emails retrieved by the operation. Take into account that this limit only applies to the emails effectively	-1
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable [non-repeatable-iterable]	Configure if repeatable streams should be used and their behaviour
Target Variable	String	The name of a variable on which the operation's output will be placed
Target Value	String	An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

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

Limit

Number

Maximum amount of emails retrieved by the operation. Take into account that this limit only applies to the emails effectively

-1

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
[non-repeatable-iterable]

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation's output will be placed

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

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

For Configurations.

POP3

Send

http://www.mulesoft.org/schema/mule/email:send

Sends an email message. The message will be 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	The 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.	[No Subject]
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 in order 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 will be sent along the email body.
Content Transfer Encoding	String	Encoding used to indicate the type of transformation that has been used in order 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

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.

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.

[No Subject]

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 in order 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 will be sent along the email body.

Content Transfer Encoding

String

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

For Configurations.

SMTP

Throws

EMAIL:RETRY_EXHAUSTED
EMAIL:CONNECTIVITY
EMAIL:ATTACHMENT

Types

Reconnection

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 will fail if the test doesn’t pass after exhausting the associated reconnection strategy
Reconnection Strategy	Reconnect Reconnect Forever	The reconnection strategy to use

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 will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

Reconnect
Reconnect Forever

The reconnection strategy to use

Reconnect

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect
Count	Number	How many reconnection attempts to make

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

Pooling Profile

Field	Type	Description
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

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

Field	Type	Description
Enabled Protocols	String	A comma separated list of protocols enabled for this context.
Enabled Cipher Suites	String	A comma separated list of cipher suites enabled for this context.
Trust Store	Trust Store
Key Store	Key Store

Field

Type

Description

Default Value

Required

Enabled Protocols

String

A comma separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

Trust Store

Key Store

Trust Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.
Password	String	The password used to protect the trust store.
Type	String	The type of store used.
Algorithm	String	The algorithm used by the trust store.
Insecure	Boolean	If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Field

Type

Description

Default Value

Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.
Type	String	The type of store used.
Alias	String	When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.
Key Password	String	The password used to protect the private key.
Password	String	The password used to protect the key store.
Algorithm	String	The algorithm used by the key store.

Field

Type

Description

Default Value

Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Stored Email Content

Field

Type

Description

Default Value

Required

Attachments

Object

Body

String

IMAP Email Attributes

Field

Type

Description

Default Value

Required

Bcc Addresses

Array of String

Cc Addresses

Array of String

Flags

Email Flags

From Addresses

Array of String

Headers

Object

Number

Received Date

DateTime

Reply To Addresses

Array of String

Sent Date

DateTime

Subject

String

To Addresses

Array of String

Email Flags

Field

Type

Description

Default Value

Required

Answered

Boolean

Deleted

Boolean

Draft

Boolean

Recent

Boolean

Seen

Boolean

Imap Matcher

Field

Type

Description

Default Value

Required

Seen

Enumeration, one of:

REQUIRE
INCLUDE
EXCLUDE

INCLUDE

Answered

Enumeration, one of:

REQUIRE
INCLUDE
EXCLUDE

INCLUDE

Deleted

Enumeration, one of:

REQUIRE
INCLUDE
EXCLUDE

INCLUDE

Recent

Enumeration, one of:

REQUIRE
INCLUDE
EXCLUDE

INCLUDE

Received Since

DateTime

Received Until

DateTime

Sent Since

DateTime

Sent Until

DateTime

Subject Regex

String

From Regex

String

Repeatable In Memory Iterable

Field	Type	Description
Initial Buffer Size	Number	This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded 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 will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.
Max Buffer Size	Number	This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded 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 will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field	Type	Description	Default Value	Required
Max In Memory Size	Number	This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which maxInMemorySize is expressed

Field

Type

Description

Default Value

Required

Max In Memory Size

Number

This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which maxInMemorySize is expressed

POP3 Email Attributes

Field

Type

Description

Default Value

Required

Bcc Addresses

Array of String

Cc Addresses

Array of String

From Addresses

Array of String

Headers

Object

Number

Received Date

DateTime

Reply To Addresses

Array of String

Sent Date

DateTime

Subject

String

To Addresses

Array of String

Pop3 Matcher

Field

Type

Description

Default Value

Required

Received Since

DateTime

Received Until

DateTime

Sent Since

DateTime

Sent Until

DateTime

Subject Regex

String

From Regex

String