Page History

...

The ServiceMix Mail component provides support for receiving and sending mails via the enterprise service bus.

Installation

Installing the servicemix-mail component can be done in several ways:

• drop the installer zip in an hotdeploy directory monitored by ServiceMix
• using ant tasks

Note that when using ant tasks, the component is not started, you will have to start it manually using ant tasks or a console.

Creation

You can use Maven to create a service unit.

Maven Archetype

You can use Maven servicemix-mail-service-unit archetype to create a service unit:

mvn archetype:create \
    -DarchetypeGroupId=org.apache.servicemix.tooling \
    -DarchetypeArtifactId=servicemix-mail-service-unit \
    -DarchetypeVersion=2010.01 \
    -DgroupId=your.group.id 

mvn archetype:create \
    -DarchetypeGroupIdDartifactId=orgyour.apacheartifact.servicemix.toolingid \
    -DarchetypeArtifactIdDversion=servicemix-mail-service-unit \
your-version

Endpoints Configuration

Poller Endpoint (Consumer)

<mail:poller service="test:myMailService"
        -DgroupId=com.mycompany.myproduct \
    -DartifactId=mycomponent.artifact

Cookbook recipes

Endpoints

<mail:sender service="test:myMailService" endpoint="pollerEndpoint"
             endpointtargetService="senderEndpointtest:myMailProcessor"
             senderperiod="no-reply@servicemix.org10000"
             receiverconnection="testreceiver@targethost.comimap://user@testserver:143/INBOX?password=myPass"
             connectiondeleteProcessedMessages="smtp://lhein@testserver?password=myPass"false"
             processOnlyUnseenMessages="true" /> 

<mail:poller service="test:myMailService"
             endpoint="pollerEndpoint"
             targetService="test:myMailProcessor"
             period="10000"
             connection="imap://lhein@testserver:143/INBOX?password=myPass"
             deleteProcessedMessages="false"
             processOnlyUnseenMessages="true" />

Consumer Endpoint (Polling)

The following table shows the additional configuration possibilities of the endpoint other than the configuration of the default PollingEndpoint class.

 
 
The DefaultMailMarshaler (used if no other is set) will convert in the following way:

• Headers of the mail are copied 1:1 into the message properties (and concatenated if needed)
• if the mail has only plain text, the content will be put to property MSG_TAG_TEXT and to the message content
• if the mail has only html, the content will be put to property MSG_TAG_HTML and to the message content
• if the mail has both plain text and html, then both will be put to the right property and the content of the message will be the plain text
• attachments are copied 1:1 from mail to message

The connection uri

The connection uri has to be specified in the following way:

 
Template: <protocol>://<user>@<host>[:<port>][/<folder>]?password=<password>
  OR  
Template: <protocol>://<host>[:<port>][/<folder>]?user=<user>;password=<password>


Example: 
   imap://lhein@imapserver:143/INBOX?password=mypass
   pop3://pop3server/INBOX?user=me@myhome.org;password=mypass

Provider Endpoint (Sending)

The following table shows the configuration possibilities of the endpoint.

The DefaultMailMarshaler (used if no other is set) will convert in the following way:

• Headers of the mail are copied 1:1 into the message properties (and concatenated if needed)
• if the mail has only plain text, the content will be put to property MSG_TAG_TEXT and to the message content
• if the mail has only html, the content will be put to property MSG_TAG_HTML and to the message content
• if the mail has both plain text and html, then both will be put to the right property and the content of the message will be the plain text
• attachments are copied 1:1 from mail to message

The connection URI

The connection uri has to be specified in the following way:

 
Template: <protocol>://<user>@<host>[:<port>][/<folder>]?password=<password>
  OR  
Template: <protocol>://<host>[:<port>][/<folder>]?user=<user>;password=<password>


Example: 
   imap://user@imapserver:143/INBOX?password=mypass
   pop3://pop3server/INBOX?user=me@myhome.org;password=mypass

Sender Endpoint (Provider)

<mail:sender service="test:myMailService" 
             endpoint="senderEndpoint"
             sender="no-reply@servicemix.org"
             receiver="testreceiver@targethost.com"
             connection="smtp://lhein@testserver?password=myPass" /> 

The

...

 
 
The DefaultMailMarshaler (used if no other is set) will convert in the following way:

...

How is the sender determined?

if If there is a preconfigured sender for the endpoint from xbean.xml, it will be used
else if MSG_TAG_FROM is defined in the message properties, then it will be used
else the method getDefaultSender() of the marshaler is invoked

...

Cookbook recipes

How to use customProperties

...