Spring Java Mail Tutorial

Spring framework provides many useful interfaces and classes for sending and receiving mails.

The org.springframework.mail package is the root package that provides mail support in Spring framework.

Spring Java Mail API

The interfaces and classes for java mail support in spring framework are as follows:

MailSender interface: It is the root interface. It provides basic functionality for sending simple mails.
JavaMailSender interface: It is the subinterface of MailSender. It supports MIME messages. It is mostly used with MimeMessageHelper class for the creation of JavaMail MimeMessage, with attachment etc. The spring framework recommends MimeMessagePreparator mechanism for using this interface.
JavaMailSenderImpl class: It provides the implementation of JavaMailSender interface. It supports JavaMail MimeMessages and Spring SimpleMailMessages.
SimpleMailMessage class: It is used to create a simple mail message including from, to, cc, subject and text messages.
MimeMessagePreparator interface: It is the callback interface for the preparation of JavaMail MIME messages.
MimeMessageHelper class: It is the helper class for creating a MIME message. It offers support for inline elements such as images, typical mail attachments and HTML text content.

Example of Sending mail in Spring by Gmail Server

In this example, we are using two spring mail classes:

SimpleMailMessage for creating message.
JavaMailSenderImpl for sending message.

You need to create following files for sending email through Spring framework.

MailMail.java
applicationContext.xml
Test.java

You need to load mail.jar and activation.jar files to run this example.

download mail.jar and activation.jar or go to the Oracle site to download the latest version.

1) MailMail.java

It is the simple class that defines mailSender property. An object of MailSender will be provided to this property at runtime.

In the sendMail() method, we are creating the instance of SimpleMailMessage and storing the information into this object such as from, to, subject and message.

The send() method of MailSender interface is used here to send the simple mail.

package com.javatpoint;
import org.springframework.mail.MailSender;
import org.springframework.mail.SimpleMailMessage;
 
public class MailMail{
	private MailSender mailSender;
 
	public void setMailSender(MailSender mailSender) {
		this.mailSender = mailSender;
	}
 
	public void sendMail(String from, String to, String subject, String msg) {
        //creating message
		SimpleMailMessage message = new SimpleMailMessage();
 		message.setFrom(from);
		message.setTo(to);
		message.setSubject(subject);
		message.setText(msg);
        //sending message
		mailSender.send(message);	
	}
}

2) applicationContext.xml

In this xml file, we are creating a bean for JavaMailSenderImpl class. We need to define values of following properties:

host
username
password
javaMailProperties

We are also creating the bean for MailMail class with mailSender property. Now, the instance of JavaMailSenderImpl class will be set in the mailSender property of MailMail class.

<?xml version="1.0" encoding="UTF-8"?>
<beans
	xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:p="http://www.springframework.org/schema/p"
	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="smtp.gmail.com" />
	<property name="username" value="yourgmailid@gmail.com" />
	<property name="password" value="yourgmailpassword" />
	<property name="javaMailProperties">
	   <props>
       	      <prop key="mail.smtp.auth">true</prop>
              <prop key="mail.smtp.socketFactory.port">465</prop>
              <prop key="mail.smtp.socketFactory.class">javax.net.ssl.SSLSocketFactory</prop>
              <prop key="mail.smtp.port">465</prop>
        </props>
	</property>
</bean>
<bean id="mailMail" class="com.javatpoint.MailMail">
	<property name="mailSender" ref="mailSender" />
</bean>
</beans>

3) Test.java

This class gets the bean of mailMail from the applicationContext.xml file and calls the sendMail method of MailMail class.

package com.javatpoint;
import org.springframework.beans.factory.*;
import org.springframework.beans.factory.xml.XmlBeanFactory;
import org.springframework.core.io.*;
public class Test {	
public static void main(String[] args) {
	
Resource r=new ClassPathResource("applicationContext.xml");
BeanFactory b=new XmlBeanFactory(r);
MailMail m=(MailMail)b.getBean("mailMail");
String sender="sendergmailid@gmail.com";//write here sender gmail id
String receiver="receiveremailid@gmail.com";//write here receiver id
m.sendMail(sender,receiver,"hi","welcome");
	
System.out.println("success");
}
}

How to run this example

Load the spring jar files for core and java mail
Load the mail.jar and activation.jar
Change the username and password property in the applicationContext.xml file, specifying your gmail id and password.
Change the sender gmail id and receivermail id in the Test.java file.
Compile and Run the Test class

download this example (developed using myeclipse IDE)

Example of Sending mail in Spring by Server provided by host provider

If you have your own site, you can use your mail server. The MailMail.java and Test class will be same. You need to change only Sender email id in the Test.java file. Some changes are required in the applicationContext.xml file.

In the applicationContext.xml file, we are using:

mail.unitedsquaad.com for the host name. Change it.
[email protected] for the username. Change it.
xxxxx for the password. Change it.

<?xml version="1.0" encoding="UTF-8"?>
<beans
	xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:p="http://www.springframework.org/schema/p"
	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.unitedsquaad.com" />
	<property name="username" value="a@unitedsquaad.com" />
	<property name="password" value="xxxxx" />
 
	<property name="javaMailProperties">
	   <props>
       	      <prop key="mail.smtp.auth">true</prop>
       	   </props>
	</property>

</bean>
<bean id="mailMail" class="MailMail">
	<property name="mailSender" ref="mailSender" />
</bean>
 
</beans>

download this example (developed using myeclipse IDE)

Sending mails to multiple receivers

You can send mails to multiple receivers by the help of SimpleMailMessage class. The setTo(String[] receivers) method of SimpleMailMessage class is used to send message to multiple receivers. Let's see the simple code.

      ....
	public void sendMail(String from, String[] to, String subject, String msg) {
        //creating message
		SimpleMailMessage message = new SimpleMailMessage();
 		message.setFrom(from);
		message.setTo(to);//passing array of recipients
		message.setSubject(subject);
		message.setText(msg);
        //sending message
		mailSender.send(message);	
	}
     ...

Spring MimeMessagePreparator Example

We can send the mime message by the help of MimeMessagePreparator interface. It has one method prepare(MimeMessage message).

Let's see the simple code to send mime message.

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

public class MailMail{
	private JavaMailSender mailSender;
 
	public void setMailSender(JavaMailSender mailSender) {
		this.mailSender = mailSender;
	}
 
	public void sendMail(final String from, final String to,final String subject,final String msg) {
			
		MimeMessagePreparator messagePreparator = new MimeMessagePreparator() {
	        
                public void prepare(MimeMessage mimeMessage) throws Exception {
                   mimeMessage.setRecipient(Message.RecipientType.TO,new InternetAddress(to));
                   mimeMessage.setFrom(new InternetAddress(from));
                   mimeMessage.setSubject(subject);
                   mimeMessage.setText(msg);
                }
        };
        mailSender.send(messagePreparator);
	}
}

The applicationContext.xml and Test.java files are same as given above.

Sending Attachment by Spring MimeMessageHelper Example

We can send the mime message with attachment in spring by the help of MimeMessageHelper class. It is recommended to use than MimeMessagePreparator.

Let's see the simple code to send mime message with attachment(image).

import java.io.File;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;

public class MailMail{
	private JavaMailSender mailSender;
 
	public void setMailSender(JavaMailSender mailSender) {
		this.mailSender = mailSender;
	}
 
	public void sendMail(final String from, final String to,final String subject,final String msg) {
		try{
		MimeMessage message = mailSender.createMimeMessage();

		MimeMessageHelper helper = new MimeMessageHelper(message, true);
		helper.setFrom(from);
		helper.setTo(to);
		helper.setSubject(subject);
		helper.setText(msg);

		// attach the file
		FileSystemResource file = new FileSystemResource(new File("c:/rr.jpg"));
		helper.addAttachment("mybrothermage.jpg", file);//image will be sent by this name

		mailSender.send(message);
		}catch(MessagingException e){e.printStackTrace();}
	}
}

The applicationContext.xml and Test.java files are same as given above.

Next TopicSpring and Struts 2 Integration Example

← prev next →