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 \
    -DgroupId=com.mycompany.myproduct \
    -DartifactId=mycomponent.artifact

Endpoints

your-version

Endpoints Configuration

Poller Endpoint (Consumer)

<mail:senderpoller service="test:myMailService" 
             endpoint="senderEndpointpollerEndpoint"
             sendertargetService="no-reply@servicemix.orgtest:myMailProcessor"
             receiverperiod="testreceiver@targethost.com10000"
             connection="smtpimap://lhein@testserveruser@testserver:143/INBOX?password=myPass" /> 

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

Consumer Endpoint (Polling)

true" />

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

 
 
The DefaultMailMarshaler 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@imapserveruser@imapserver:143/INBOX?password=mypass
   pop3://pop3server/INBOX?user=me@myhome.org;password=mypass

...

Sender Endpoint (

...

Provider)

...

Code Block
lang xml

The following table shows the configuration possibilities of the endpoint.

info

title Sender (provider) endpoint attributes borderStyle solidbgColor='lighblue'

Name Type Description Default connection string sets the connection information null (must be spec'd) sender string defines the sender address of the mail no-reply@localhost receiver string defines the receiver address of the mail null marshaler class org.apache.servicemix.mail.marshaler.AbstractMailMarshaler DefaultMailMarshaler debugMode boolean sets the debug mode for the javamail api false ignoreMessageProperties java.util.List a list TO address in the IN message will be ignored false customProperties java.util.Map a map of custom properties for the connection null customTrustManagers string sets one or more custom trust managers for use with ssl null

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

...

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

Info
title Sender Endpoint Attributes borderStyle solidbgColor='lighblue'
Name Type Description Default connection string sets the connection information null (must be spec'd) sender string defines the sender address of the mail no-reply@localhost receiver string defines the receiver address of the mail null marshaler class org.apache.servicemix.mail.marshaler.AbstractMailMarshaler DefaultMailMarshaler debugMode boolean sets the debug mode for the javamail api false ignoreMessageProperties java.util.List a list of properties of the IN message which will be ignored false customProperties java.util.Map a map of custom properties for the connection null customTrustManagers string sets one or more custom trust managers for use with ssl null

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

• all properties of the message MSG_TAG_xxxx will be evaluated and used for preparing the mail
• if MSG_TAG_TEXT and/or MSG_TAG_HTML are specified, then the content will be used for preparing the mail content
• if there are no MSG_TAG_TEXT and MSG_TAG_HTML properties, the content of the message will be parsed and converted to the mail body as plain text or html content
• attachments are copied

...

• 1:1 from mail to message

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

Via this attribute you can provide a map of properties which will be applied to the connection properties. Doing so enables you to
completely configure the connection properties.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:mail="http://servicemix.apache.org/mail/1.0"
       xmlns:test="http://www.servicemix.org/example"
       xmlns:util="http://www.springframework.org/schema/util">

<mail:poller service="test:myMailService"
             endpoint="pollerEndpoint"

For all xbean file endpoint configuration take a look at Xml schemas

Marshalers

You can write your own marshalers for conversion between mail and normalized message and vice versa.
To do this you simply need to subclass the org.apache.servicemix.mail.marshaler.AbstractMailMarshaler or even the
DefaultMailMarshaler if you don't want to start from scratch.

Subclassing the AbstractMailMarshaler

For providing your own marshaler you only need to implement two methods:

convertMailToJBI(...)

This method is responsible for translating a received mail message into a jbi compliant normalized message ready to be sent to the bus.

convertJBIToMail(...)

This method is responsible for translating a received normalized message into a mail message ready to be sent to the mail server.

After finishing your marshaler you can simply configure your endpoints to use it:

<mail:poller service="test:myMailService" 
             endpointtargetService="senderEndpointtest:myMailProcessor"
             senderperiod="no-reply@servicemix.org10000" 
             connection="imap://lhein@testserver:143/INBOX?password=myPass" > 


             deleteProcessedMessages="false"
            <property nameprocessOnlyUnseenMessages="marshalertrue"> 
        <bean class="com.mycompany.MyMailMarshaler" />
    </property>

</mail:poller>

Mapping of headers and properties

All mail headers are mapped (nearly) one-to-one into message properties. If there are multiple mail headers with the same name, then the values will be concatenated and separated by the semicolon (;-character).

There are some more important properties which affect the handling of the message / mail (constants are defined in AbstractMailMarshaler):

     customProperties="#customProps"/>

  <util:map id="customProps">
    <entry key="mail.pop3.forgettopheaders" value="true" />
  </util:map>

</beans>

For a list of properties used by the SUN implementation influencing the connection have a look at the Mail API documentation:
http://java.sun.com/products/javamail/javadocs/overview-summary.html
Have especially a look at the protocol specific package summaries.

How to use ignoreMessageProperties

Via this property you can provide a list of properties of the normalized in message which will be set to null
before marshaling it. This will enable you for example to have a simple email forward bridge with a poller and a
sender which will forward the received message to a new email address. Without skipping at least the TO address property
the mail would be sent again to the account you are polling from (see how the receiver is determined).

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:mail="http://servicemix.apache.org/mail/1.0"
       xmlns:test="http://www.servicemix.org/example"
       xmlns:util="http://www.springframework.org/schema/util">

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

  <util:list id="ignoreProps">
    <value>org.apache.servicemix.mail.to</value>
    <value>org.apache.servicemix.mail.cc</value>
    <value>org.apache.servicemix.mail.bcc</value>
    <value>org.apache.servicemix.mail.from</value>
    <value>org.apache.servicemix.mail.replyto</value>
  </util:list>

</beans>

For all xbean file endpoint configuration take a look at Xml schemas

Marshalers

You can write your own marshalers for conversion between mail and normalized message and vice versa.
To do this you simply need to subclass the org.apache.servicemix.mail.marshaler.AbstractMailMarshaler or even the
DefaultMailMarshaler if you don't want to start from scratch.

Subclassing the AbstractMailMarshaler

For providing your own marshaler you only need to implement two methods:

convertMailToJBI(...)

This method is responsible for translating a received mail message into a jbi compliant normalized message ready to be sent to the bus.

convertJBIToMail(...)

This method is responsible for translating a received normalized message into a mail message ready to be sent to the mail server.

After finishing your marshaler you can simply configure your endpoints to use it:

<mail:poller service="test:myMailService" 
             endpoint="senderEndpoint"
             sender="no-reply@servicemix.org" 
             connection="imap://lhein@testserver:143?password=myPass" > 

    <property name="marshaler">
        <bean class="com.mycompany.MyMailMarshaler" />
    </property>

</mail:poller>

Mapping of headers and properties

All mail headers are mapped (nearly) one-to-one into message properties. If there are multiple mail headers with the same name, then the values will be concatenated and separated by the semicolon (;-character).

There are some more important properties which affect the handling of the message / mail (constants are defined in AbstractMailMarshaler):

Mail Content Types

These are the available content types:

• text/plain
• text/html
• text/xml
• multipart/*
• multipart/mixed
• multipart/alternative
• unknown

On incoming mails you may evaluate this property on the normalized message to find out which kind of mime type the mail had. On outgoing mails you can control the mime type to use for the mail. If you don't set the content type it will be auto-sensed by the marshaler.
 
 

IMAPS and POP3S

If you want to use secure protocols like IMAPS or POP3S you have several oportunities to do that.

...