IMAP Connector

Thanh Nguyen

Instructions

• The IMAP Connector implements an IMAP transport channel that enables your Mule application to retrieve email from an IMAP email server

• IMAP is similar to POP3, except IMAP supports both online and offline modes

• Like POP3, IMAP cannot send email; for that, you must use an SMTP outbound endpoint

Instructions

• For a secure transport channel (either TLS or SSL), you can specify the IMAPS protocol

Configuring

• Place your IMAP endpoint at the head of the sequence of building blocks that make up your Mule flow.

• Configure the IMAP endpoint by providing values for the fields on the various tabs on the properties editor

General Tab

General Tab

Property DescriptionDisplay Name Defaults to the generic

endpoint name. Change the display name, which must be alpha-numeric, to reflect the endpoint’s specific role in the flow, such as Incoming Email

Host Enter the Fully Qualified Domain Name (FQDN) or IP address of the IMAP server from which email is retrieved. Defaults to localhost.

General Tab

Port The port number that connects to the IMAP server. The default is 143 for IMAP, 993 for IMAPS.

User The username for authentication on the IMAP server.

Password The password for authentication on the IMAP server.

General Tab

Connector Configuration Use the dropdown list to select a previously created connector configuration for this endpoint. If you have not created a connector configuration for this type of endpoint, you can do so from this window by clicking Add . Click Edit to modify a previously created global element.

Properties Enter a key, value, and value reference for the IMAP server

Advanced Tab

Advanced TabProperty Description

Address Specify the URL of the IMAP server from which email is to be retrieved.

Response Timeout Specify how long (in milliseconds) the endpoint must wait for a response from the IMAP server. The default is 10000 ms.

Advanced Tab

Encoding Choose from a drop-down list the character set used for message data. (Such as, UTF-8.)

Disable Transport Transformer

Check this box if you do not want to use the endpoint’s default response transport.

MIME Type Select from the dropdown list one of the formats this endpoint supports.

Advanced TabConnector Endpoint Use the drop-down list to

select a previously configured global endpoint template, if any exist. If you have not created a global element for this type of endpoint, you do so by clicking Add and completing the fields on the pane that appears. Click Edit to modify a previously created global element.

Enable default events tracking

Enable default  business event  tracking for this endpoint

Reconnection Tab

Transformers Tab

Transformers Tab

Field Description

Request Transformer References

Enter a list of synchronous transformers to apply to the request before it is sent to the transport.

Response Transformer References

Enter a list of synchronous transformers to apply to the response before it is returned from the transport.

Security Tab

Security Tab

Property Description

IMAPS Check this box to enable IMAPS. Messages are sent over a secure socket layer. Messages are sent over a secure socket layer. By default, IMAPS is turned off.

Question and answer