25. Email
Prev | Part VI. Integration | Next

## 25. Email

## 25.1 Introduction

The Spring Framework provides a helpful utility library for sending email that shields the user from the specifics of the underlying mailing system and is responsible for low level resource handling on behalf of the client.

The `org.springframework.mail` package is the root level package for the Spring Framework's email support. The central interface for sending emails is the `MailSender` interface; a simple value object encapsulating the properties of a simple mail such as from and to (plus many others) is the `SimpleMailMessage` class. This package also contains a hierarchy of checked exceptions which provide a higher level of abstraction over the lower level mail system exceptions with the root exception being `MailException`. Please refer to the JavaDocs for more information on the rich mail exception hierarchy.

The `org.springframework.mail.javamail.JavaMailSender` interface adds specialized JavaMail features such as MIME message support to the `MailSender` interface (from which it inherits). `JavaMailSender` also provides a callback interface for preparation of JavaMail MIME messages, called `org.springframework.mail.javamail.MimeMessagePreparator`

## 25.2 Usage

Let's assume there is a business interface called `OrderManager`:

    public interface OrderManager {

        void placeOrder(Order order);
    }

Let us also assume that there is a requirement stating that an email message with an order number needs to be generated and sent to a customer placing the relevant order.

### 25.2.1 Basic `MailSender` and `SimpleMailMessage` usage

    import org.springframework.mail.MailException;
    import org.springframework.mail.MailSender;
    import org.springframework.mail.SimpleMailMessage;

    public class SimpleOrderManager implements OrderManager {

        private MailSender mailSender;
        private SimpleMailMessage templateMessage;

        public void setMailSender(MailSender mailSender) {
            this.mailSender = mailSender;
        }

        public void setTemplateMessage(SimpleMailMessage templateMessage) {
            this.templateMessage = templateMessage;
        }

        public void placeOrder(Order order) {

            // Do the business calculations...

            // Call the collaborators to persist the order...

            // Create a thread safe "copy" of the template message and customize it
            SimpleMailMessage msg = new SimpleMailMessage(this.templateMessage);
            msg.setTo(order.getCustomer().getEmailAddress());
            msg.setText(
                "Dear " + order.getCustomer().getFirstName()
                    + order.getCustomer().getLastName()
                    + ", thank you for placing order. Your order number is "
                    + order.getOrderNumber());
            try{
                this.mailSender.send(msg);
            }
            catch(MailException ex) {
                // simply log it and go on...
                System.err.println(ex.getMessage());
            }
        }
    }

Find below the bean definitions for the above code:

    <bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
      <property name="host" value="mail.mycompany.com"/>
    </bean>

    <!-- this is a template message that we can pre-load with default state -->
    <bean id="templateMessage" class="org.springframework.mail.SimpleMailMessage">
      <property name="from" value="customerservice@mycompany.com"/>
      <property name="subject" value="Your order"/>
    </bean>

    <bean id="orderManager" class="com.mycompany.businessapp.support.SimpleOrderManager">
      <property name="mailSender" ref="mailSender"/>
      <property name="templateMessage" ref="templateMessage"/>
    </bean>

### 25.2.2 Using the `JavaMailSender` and the `MimeMessagePreparator`

Here is another implementation of `OrderManager` using the `MimeMessagePreparator` callback interface. Please note in this case that the `mailSender` property is of type `JavaMailSender` so that we are able to use the JavaMail `MimeMessage` class:

    import javax.mail.Message;
    import javax.mail.MessagingException;
    import javax.mail.internet.InternetAddress;
    import javax.mail.internet.MimeMessage;

    import javax.mail.internet.MimeMessage;
    import org.springframework.mail.MailException;
    import org.springframework.mail.javamail.JavaMailSender;
    import org.springframework.mail.javamail.MimeMessagePreparator;

    public class SimpleOrderManager implements OrderManager {

        private JavaMailSender mailSender;

        public void setMailSender(JavaMailSender mailSender) {
            this.mailSender = mailSender;
        }

        public void placeOrder(final Order order) {

            // Do the business calculations...

            // Call the collaborators to persist the order...

            MimeMessagePreparator preparator = new MimeMessagePreparator() {

                public void prepare(MimeMessage mimeMessage) throws Exception {

                    mimeMessage.setRecipient(Message.RecipientType.TO,
                            new InternetAddress(order.getCustomer().getEmailAddress()));
                    mimeMessage.setFrom(new InternetAddress("mail@mycompany.com"));
                    mimeMessage.setText(
                        "Dear " + order.getCustomer().getFirstName() + " "
                            + order.getCustomer().getLastName()
                            + ", thank you for placing order. Your order number is "
                            + order.getOrderNumber());
                }
            };
            try {
                this.mailSender.send(preparator);
            }
            catch (MailException ex) {
                // simply log it and go on...
                System.err.println(ex.getMessage());
            }
        }
    }

| Note
The mail code is a crosscutting concern and could well be a candidate for refactoring into a custom Spring AOP aspect, which then could be executed at appropriate joinpoints on the `OrderManager` target.

The Spring Framework's mail support ships with the standard JavaMail implementation. Please refer to the relevant JavaDocs for more information.

## 25.3 Using the JavaMail `MimeMessageHelper`

A class that comes in pretty handy when dealing with JavaMail messages is the `org.springframework.mail.javamail.MimeMessageHelper` class, which shields you from having to use the verbose JavaMail API. Using the `MimeMessageHelper` it is pretty easy to create a `MimeMessage`:

    // of course you would use DI in any real-world cases
    JavaMailSenderImpl sender = new JavaMailSenderImpl();
    sender.setHost("mail.host.com");

    MimeMessage message = sender.createMimeMessage();
    MimeMessageHelper helper = new MimeMessageHelper(message);
    helper.setTo("test@host.com");
    helper.setText("Thank you for ordering!");

    sender.send(message);

### 25.3.1 Sending attachments and inline resources

Multipart email messages allow for both attachments and inline resources. Examples of inline resources would be images or a stylesheet you want to use in your message, but that you don't want displayed as an attachment.

#### 25.3.1.1 Attachments

The following example shows you how to use the `MimeMessageHelper` to send an email along with a single JPEG image attachment.

    JavaMailSenderImpl sender = new JavaMailSenderImpl();
    sender.setHost("mail.host.com");

    MimeMessage message = sender.createMimeMessage();

    // use the true flag to indicate you need a multipart message
    MimeMessageHelper helper = new MimeMessageHelper(message, true);
    helper.setTo("test@host.com");

    helper.setText("Check out this image!");

    // let's attach the infamous windows Sample file (this time copied to c:/)
    FileSystemResource file = new FileSystemResource(new File("c:/Sample.jpg"));
    helper.addAttachment("CoolImage.jpg", file);

    sender.send(message);

#### 25.3.1.2 Inline resources

The following example shows you how to use the `MimeMessageHelper` to send an email along with an inline image.

    JavaMailSenderImpl sender = new JavaMailSenderImpl();
    sender.setHost("mail.host.com");

    MimeMessage message = sender.createMimeMessage();

    // use the true flag to indicate you need a multipart message
    MimeMessageHelper helper = new MimeMessageHelper(message, true);
    helper.setTo("test@host.com");

    // use the true flag to indicate the text included is HTML
    helper.setText("<html><body><img src='cid:identifier1234'></body></html>", true);

    // let's include the infamous windows Sample file (this time copied to c:/)
    FileSystemResource res = new FileSystemResource(new File("c:/Sample.jpg"));
    helper.addInline("identifier1234", res);

    sender.send(message);

| Warning
Inline resources are added to the mime message using the specified `Content-ID` (`identifier1234` in the above example). The order in which you are adding the text and the resource are very important. Be sure to first add the text and after that the resources. If you are doing it the other way around, it won't work!

### 25.3.2 Creating email content using a templating library

The code in the previous examples explicitly created the content of the email message, using methods calls such as `message.setText(..)`. This is fine for simple cases, and it is okay in the context of the aforementioned examples, where the intent was to show you the very basics of the API.

In your typical enterprise application though, you are not going to create the content of your emails using the above approach for a number of reasons.

- Creating HTML-based email content in Java code is tedious and error prone

- There is no clear separation between display logic and business logic

- Changing the display structure of the email content requires writing Java code, recompiling, redeploying...

Typically the approach taken to address these issues is to use a template library such as FreeMarker or Velocity to define the display structure of email content. This leaves your code tasked only with creating the data that is to be rendered in the email template and sending the email. It is definitely a best practice for when the content of your emails becomes even moderately complex, and with the Spring Framework's support classes for FreeMarker and Velocity becomes quite easy to do. Find below an example of using the Velocity template library to create email content.

#### 25.3.2.1 A Velocity-based example

To use Velocity to create your email template(s), you will need to have the Velocity libraries available on your classpath. You will also need to create one or more Velocity templates for the email content that your application needs. Find below the Velocity template that this example will be using. As you can see it is HTML-based, and since it is plain text it can be created using your favorite HTML or text editor.

    # in the com/foo/package
    <html>
    <body>
    <h3>Hi ${user.userName}, welcome to the Chipping Sodbury On-the-Hill message boards!</h3>

    <div>
       Your email address is <a href="mailto:${user.emailAddress}">${user.emailAddress}</a>.
    </div>
    </body>

    </html>

Find below some simple code and Spring XML configuration that makes use of the above Velocity template to create email content and send email(s).

    package com.foo;

    import org.apache.velocity.app.VelocityEngine;
    import org.springframework.mail.javamail.JavaMailSender;
    import org.springframework.mail.javamail.MimeMessageHelper;
    import org.springframework.mail.javamail.MimeMessagePreparator;
    import org.springframework.ui.velocity.VelocityEngineUtils;

    import javax.mail.internet.MimeMessage;
    import java.util.HashMap;
    import java.util.Map;

    public class SimpleRegistrationService implements RegistrationService {

       private JavaMailSender mailSender;
       private VelocityEngine velocityEngine;

       public void setMailSender(JavaMailSender mailSender) {
          this.mailSender = mailSender;
       }

       public void setVelocityEngine(VelocityEngine velocityEngine) {
          this.velocityEngine = velocityEngine;
       }

       public void register(User user) {

          // Do the registration logic...

          sendConfirmationEmail(user);
       }

       private void sendConfirmationEmail(final User user) {
          MimeMessagePreparator preparator = new MimeMessagePreparator() {
             public void prepare(MimeMessage mimeMessage) throws Exception {
                MimeMessageHelper message = new MimeMessageHelper(mimeMessage);
                message.setTo(user.getEmailAddress());
                message.setFrom("webmaster@csonth.gov.uk"); // could be parameterized...
                Map model = new HashMap();
                model.put("user", user);
                String text = VelocityEngineUtils.mergeTemplateIntoString(
                   velocityEngine, "com/dns/registration-confirmation.vm", model);
                message.setText(text, true);
             }
          };
          this.mailSender.send(preparator);
       }
    }

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

       <bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
          <property name="host" value="mail.csonth.gov.uk"/>
       </bean>

       <bean id="registrationService" class="com.foo.SimpleRegistrationService">
          <property name="mailSender" ref="mailSender"/>
          <property name="velocityEngine" ref="velocityEngine"/>
       </bean>

       <bean id="velocityEngine" class="org.springframework.ui.velocity.VelocityEngineFactoryBean">
          <property name="velocityProperties">
             <value>
              resource.loader=class
              class.resource.loader.class=org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader
             </value>
          </property>
       </bean>

    </beans>

Prev | Up | Next
24. JCA CCI | Home | 26. Task Execution and Scheduling