13.7.8. EmailRouter

Class org.jboss.soa.esb.actions.routing.email.EmailRouter
Routes the incoming message to a configured email account.

Table 13.21. EmailRouter Properties

Property Description Required
unwrap
true will extract the message payload from the Message object before sending. false (the default) will send the serialized Message object.
 
host
The host name of the SMTP server. If not specified will default to the property 'org.jboss.soa.esb.mail.smtp.host' in jbossesb-properties.xml.
 
port
The port for the SMTP server. If not specified will default to the property 'org.jboss.soa.esb.mail.smtp.port' in jbossesb-properties.xml.
 
username
The username for the SMTP server. If not specified will default to the property 'org.jboss.soa.esb.mail.smtp.user' in jbossesb-properties.xml.
 
password
The password for the above username on the SMTP server. If not specified will default to the property 'org.jboss.soa.esb.mail.smtp.password' in jbossesb-properties.xml.
 
auth
If true will attempt to authenticate the user using the AUTH command. If not specified will default to the property 'org.jboss.soa.esb.mail.smtp.auth' in jbossesb-properties.xml
 
from
The from email address.
 
sendTo
The destination email account.
 
subject
The subject of the email.
 
messageAttachmentName
filename of an attachment containing the message payload (optional). If not specified the message payload will be included in the message body.
 
message
a string to be prepended to the ESB message contents which make up the e-mail message (optional)
 
ccTo
comma-separated list of email addresses (optional)
 
attachment
Child elements that contain files that will be added as attachments to the email sent.
 

<action name="send-email"  class="org.jboss.soa.esb.actions.routing.email.EmailRouter">
    <property name="unwrap" value="true" /> 
    <property name="host" value="smtpHost" /> 
    <property name="port" value="25" /> 
    <property name="username" value="smtpUser" /> 
    <property name="password" value="smtpPassword" /> 
    <property name="from" value="jbossesb@xyz.com" /> 
    <property name="sendTo" value="system2@xyz.com" /> 
    <property name="subject" value="Message Subject" />  
</action>