Contact Free trial Login

Email Connector Reference - Mule 4

Support Category: Select

Email Connector v1.2

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.

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

The connection types to provide to this configuration.

x

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Enables you to specify a strategy for how to name attachments

NAME

Eagerly Fetch Content

Boolean

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

true

Expiration Policy

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

Connection Types

IMAP Connection

A Connection Provider that returns instances of IMAP-based Mailbox connections.

Parameters
Name Type Description Default Value Required

Properties

Object

An additional set of custom properties to configure the connection session

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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

SECONDS

Connection Timeout

Number

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

5

Read Timeout

Number

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

5

Write Timeout

Number

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

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

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

IMAPS Connection

A Connection Provider that returns instances of IMAPs (secure) based Mailbox Connections.

The returned connection is secured by TLS.

Parameters
Name Type Description Default Value Required

Properties

Object

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

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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

SECONDS

Connection Timeout

Number

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

5

Read Timeout

Number

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

5

Write Timeout

Number

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

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

TLS Configuration

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

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

The 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

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 the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when appropriate.

Connection Types

POP3 Connection

A Connection Provider that returns instances of POP-based Mailbox Connections.

Parameters
Name Type Description Default Value Required

Properties

Object

An additional set of custom properties to configure the connection session

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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

SECONDS

Connection Timeout

Number

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

5

Read Timeout

Number

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

5

Write Timeout

Number

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

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

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

POP3S Connection

A Connection Provider that returns instances of POP3s (secured) based Mailbox Connections. The returned connection is secured by TLS.

Parameters
Name Type Description Default Value Required

Properties

Object

An additional set of custom 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.

SECONDS

Connection Timeout

Number

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

5

Read Timeout

Number

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

5

Write Timeout

Number

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

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

TLS Configuration

TlS

TLS configuration for the secure connection of the POP3S 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

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

The 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" address of the message sender

Default Encoding

String

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

Default Content Transfer Encoding

String

Expiration Policy

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

Connection Types

SMTP Connection

A Connection Provider that returns instances of SMTP-based Sender Connections.

Parameters
Name Type Description Default Value Required

Properties

Object

An additional set of custom properties to configure the connection session

Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit that qualifies the connectionTimeout, writeTimeout and readTimeout attributes.

SECONDS

Connection Timeout

Number

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

5

Read Timeout

Number

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

5

Write Timeout

Number

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

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

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

SMTPS Connection

A Connection Provider that returns instances of SMTPS-based Mailbox Connections. The returned connection is secured by TLS.

Parameters
Name Type Description Default Value Required

Properties

Object

An additional set of custom 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.

SECONDS

Connection Timeout

Number

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

5

Read Timeout

Number

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

5

Write Timeout

Number

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

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

TLS Configuration

TlS

TLS Configuration for the secure connection of the SMTPS 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

Supported Operations

Operations

Delete

<email:delete>

Deletes the email with the specified email ID from the mailbox.

For IMAP mailboxes all the messages scheduled for deletion (marked as DELETED) are also 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 from which to delete the emails

INBOX

Email ID

Number

Email ID Number of the email to delete

x

Reconnection Strategy

A 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>

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

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 scheduled to be permanently deleted

INBOX

Reconnection Strategy

A 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 mailbox folder that matches with the specified IMAP Matcher criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Mailbox Folder

String

Mailbox folder from which to fetch the emails

INBOX

Match with

Email Matcher that gives the capability of filtering the retrieved emails

Delete After Retrieve

Boolean

Specifies whether to delete the returned emails after they are retrieved

false

Page Size

Number

Size of the page used by the Paging Provider 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 applies only to the emails effectively retrieved by the operation (the ones that match the IMAPEmailPredicateBuilder criteria) and doesn’t imply any restriction over the amount of emails being retrieved from the mailbox server.

-1

Streaming Strategy

Configure to use repeatable streams

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Enables you to specify a strategy for how to name attachments

NAME

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

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

Throws

  • EMAIL:EMAIL_LIST

  • EMAIL:CONNECTIVITY

Mark As Deleted

<email:mark-as-deleted>

Marks an incoming email as DELETED. Emails that are marked for deletion are scheduled for deletion when the folder closes, which means that the email is not physically eliminated from the mailbox folder, but its state changes. All emails that are marked as DELETED are 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

A 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 its state in the specified mailbox folder. This operation can target 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

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • EMAIL:EMAIL_NOT_FOUND

  • EMAIL:ACCESSING_FOLDER

  • EMAIL:CONNECTIVITY

  • EMAIL:RETRY_EXHAUSTED

List - POP3

<email:list-pop3>

List all the emails (with pagination) in the configured POP3 mailbox folder that matches the specified POP3 Matcher criteria. The POP3 protocol does not support the capability of finding specific emails from its UID in a folder to move/delete it, so 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

The name of the configuration to use.

x

Mailbox Folder

String

Mailbox folder where the emails are going to be fetched

INBOX

Match with

Email Matcher that gives the capability of filtering 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 Paging Provider 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 applies only to the emails effectively retrieved by the operation (the ones that matched the IMAPEmailPredicateBuilder criteria) and doesn’t imply any restriction over the number of emails being retrieved from the mailbox server.

-1

Streaming Strategy

Configure to use repeatable streams.

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Enables you to specify a strategy for how to name attachments

NAME

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

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

Throws

  • EMAIL:EMAIL_LIST

  • EMAIL:CONNECTIVITY

Send

<email:send>

This operation sends an email message. The message is sent to all recipient To, CC, and BCC addresses specified in the message. The content of the message is some type of text (text/plain, text/html) and is composed of the body and its content type. If no content is specified then the incoming payload is 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" address of the message sender. 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 to reply to this email

Subject

String

The subject of the email

Headers

Object

The headers that this email carries

Content

Binary

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

#[payload]

ContentType

String

Content Type 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.

Attachments

Object

The attachments that are sent along with the email body

Content Transfer Encoding

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

Reconnection Strategy

A 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

The name of the configuration to use.

x

Folder

String

The name of the folder to poll emails from.

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

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

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in Cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Enables you to specify a strategy for how to name attachments

NAME

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Stored Email Content

Attributes Type

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

The name of the configuration to use

x

Folder

String

The name of the folder to poll emails from

INBOX

Delete After Retrieve

Boolean

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

false

Pop3 Matcher

A matcher to filter emails retrieved by this polling source

Primary Node Only

Boolean

Whether this source should be executed on the primary node only when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Attachment Naming Strategy

Enumeration, one of:

  • NAME

  • NAME_HEADERS

  • NAME_HEADERS_SUBJECT

Enables you to specify a strategy for how to name attachments

NAME

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Stored Email Content

Attributes Type

For Configurations

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

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

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 can 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 is thrown. If maxThreadWait is a negative value, it blocks 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 (loads no components into the pool on startup), INITIALISE_ONE (loads one initial component into the pool on startup), or INITIALISE_ALL (loads all components in the pool on startup)

Disabled

Boolean

Whether pooling should be disabled

TlS

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

Revocation Check

Trust 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 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 are performed, which makes connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which is 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

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Verify only the last element of the certificate chain

Prefer Crls

Boolean

Try CRL instead of OCSP first

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before)

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

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

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 whether to retrieve 'seen' or 'not seen' emails

INCLUDE

Answered

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

Indicates whether to retrieve 'answered' or 'not answered' emails

INCLUDE

Deleted

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

Indicates whether to retrieve 'marked as deleted' or 'not marked as deleted' emails

INCLUDE

Recent

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

Indicates whether to retrieve recent or not recent emails

INCLUDE

Received Since

DateTime

Indicates the date after which to retrieve received emails

Received Until

DateTime

Indicates the date until which to retrieve the received emails

Sent Since

DateTime

Indicates the date after which to retrieve sent emails

Sent Until

DateTime

Indicates the date until which to retrieve sent emails

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

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

SHA-256

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property can be set only if Use secure hash is false.

Object Store

Object Store

The object store in which to store the redelivery counter for each message.

IMAP Email Attributes

Field Type Description Default Value Required

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

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 number of instances that are initially 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.

100

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.

100

Max Buffer Size

Number

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

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances that will be kept in memory. If more than that is required, content starts to buffer on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

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

x

Subject

String

x

Received Date

DateTime

Sent Date

DateTime