Hướng dẫn và ví dụ Spring Email

Tổng quan về Spring Mail
Chú ý cho Gmail
Cấu hình Spring Mail
Ví dụ gửi Email đơn giản
Gửi Email đính kèm tập tin
Gửi email định dạng HTML

1. Tổng quan về Spring Mail

Spring Framework cung cấp cho bạn một API để gửi email, nó bao gồm một vài interface và một vài lớp, tất cả nằm trong 2 package org.springframework.mail & org.springframework.mail.javamail.

Để sử dụng Spring Mail trong ứng dụng Spring Boot, hãy thêm phụ thuộc sau vào pom.xml:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
        http://maven.apache.org/xsd/maven-4.0.0.xsd">
        
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.o7planning</groupId>
    <artifactId>SpringBootMail</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>SpringBootMail</name>
    <description>Spring Boot + Mail</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>        
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Spring Mail cũng không có nhiều các lớp (hoặc interface), về cơ bản dưới đây là danh sách các lớp và interface chính:

org.springframework.mail.MailSender
org.springframework.mail.SimpleMailMessage
org.springframework.mail.MailMessage
org.springframework.mail.javamail.JavaMailSender
org.springframework.mail.javamail.JavaMailSenderImpl
org.springframework.mail.javamail.MimeMessagePreparator
org.springframework.mail.javamail.MimeMessageHelper
org.springframework.mail.javamail.MimeMailMessage

MIME (Multi-Purpose Internet Mail Extensions):
MIME (Multi-Purpose Internet Mail Extensions): (Phần mở rộng đa mục đích cho Internet Mail) Là một phần mở rộng của giao thức Internet Email ban đầu. Nó cho phép gửi các Email có đính kèm các kiểu dữ liệu khác nhau trên Internet như audio, video, image,.., và hỗ trợ các Email có định dạng HTML.

Class/Interface	Mô tả
MailSender	Đây là một interface ở mức cao nhất (top-level), nó cung cấp các chức năng để gửi một email đơn giản.
JavaMailSender	Đây là interface con (subinterface) của MailSender, nó hỗ trợ các tin nhắn kiểu MIME, nó thường đươc sử dụng với lớp MimeMessageHelper để tạo ra MimeMessage. Một lời khuyên là nên sử dụng interface MimeMessagePreparator cùng với interface này.
JavaMailSenderImpl	Là một lớp thực hiện interface JavaMailSender. Nó hỗ trợ gửi các tin nhắn MimeMessage và SimpleMailMessage.
MailMessage	Là một interface đại diện cho một tin nhắn (message) đơn giản. Nó bao gồm các thông tin cơ bản của một email như người gửi, người nhận, tiêu đề (subject) và nội tin nhắn.
SimpleMailMessage	Đây là một lớp thực hiện (implements) interface MailMessage, được sử dụng để tạo một tin nhắn (message) đơn giản.
MimeMailMessage	Đây là một lớp thực hiện interface MailMessage, được sử dụng để tạo ra một tin nhắn hỗ trợ MIME.
MimeMessagePreparator	Interface này cung cấp phương thức callback được gọi khi chuẩn bị một tin nhắn MIME.
MimeMessageHelper	Là một lớp trợ giúp để tạo ra một tin nhắn MIME, nó hỗ trợ image, và các tập tin đính kèm, và tạo ra các tin nhắn kiểu HTML.

2. Chú ý cho Gmail

Trong bài học này tôi sẽ sử dụng một tài khoản Gmail để gửi tin nhắn, vì Gmail là một Mail-Server rất thông dụng. Tuy nhiên để tài khoản Gmail của bạn có thể gửi email thông qua một ứng dụng Java bạn phải nói với Google cho phép điều đó. OK, trước hết, trên trình duyệt bạn hãy đăng nhập vào tài khoản Gmail của bạn, sau đó truy cập vào địa chỉ dưới đây:

https://www.google.com/settings/security/lesssecureapps

Kích hoạt cho phép tài khoản Gmail của bạn được sử dụng bởi các ứng dụng ít bảo mật hơn (Less Secure Apps).

https://support.google.com/domains/answer/9437157?hl=en

3. Cấu hình Spring Mail

Trong ứng dụng Spring, bạn nên tạo một Spring-Bean cho MailSender. Ví dụ dưới đây tôi sử dụng một tài khoản Gmail để gửi email.

MailConfig.java

package org.o7planning.sbmail.config;

import java.util.Properties;

import org.o7planning.sbmail.MyConstants;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.JavaMailSenderImpl;

@Configuration
public class MailConfig {

    @Bean
    public JavaMailSender getJavaMailSender() {
        JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
        mailSender.setHost("smtp.gmail.com");
        mailSender.setPort(587);

        mailSender.setUsername(MyConstants.MY_EMAIL);
        mailSender.setPassword(MyConstants.MY_PASSWORD);

        Properties props = mailSender.getJavaMailProperties();
        props.put("mail.transport.protocol", "smtp");
        props.put("mail.smtp.auth", "true");
        props.put("mail.smtp.starttls.enable", "true");
        props.put("mail.debug", "true");

        return mailSender;
    }

}

MyConstants.java

package org.o7planning.sbmail;

public class MyConstants {

    // Replace with your email here:  
    public static final String MY_EMAIL = "yourEmail@gmail.com";

    // Replace password!!
    public static final String MY_PASSWORD = "yourPassword";

    // And receiver!
    public static final String FRIEND_EMAIL = "yourFriend@gmail.com";

}

4. Ví dụ gửi Email đơn giản

Đây là một ví dụ rất đơn giản, gửi một email với nội dung văn bản thông thường.

SimpleEmailExampleController.java

package org.o7planning.sbmail.controller;

import org.o7planning.sbmail.MyConstants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class SimpleEmailExampleController {

    @Autowired
    public JavaMailSender emailSender;

    @ResponseBody
    @RequestMapping("/sendSimpleEmail")
    public String sendSimpleEmail() {

        // Create a Simple MailMessage.
        SimpleMailMessage message = new SimpleMailMessage();
        
        message.setTo(MyConstants.FRIEND_EMAIL);
        message.setSubject("Test Simple Email");
        message.setText("Hello, Im testing Simple Email");

        // Send Message!
        this.emailSender.send(message);

        return "Email Sent!";
    }

}

http://localhost:8080/sendSimpleEmail

5. Gửi Email đính kèm tập tin

AttachmentEmailExampleController.java

package org.o7planning.sbmail.controller;

import java.io.File;

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

import org.o7planning.sbmail.MyConstants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class AttachmentEmailExampleController {

    @Autowired
    public JavaMailSender emailSender;

    @ResponseBody
    @RequestMapping("/sendAttachmentEmail")
    public String sendAttachmentEmail() throws MessagingException {

        MimeMessage message = emailSender.createMimeMessage();

        boolean multipart = true;

        MimeMessageHelper helper = new MimeMessageHelper(message, multipart);

        helper.setTo(MyConstants.FRIEND_EMAIL);
        helper.setSubject("Test email with attachments");
        
        helper.setText("Hello, Im testing email with attachments!");
        
        String path1 = "/home/tran/Downloads/test.txt";
        String path2 = "/home/tran/Downloads/readme.zip";

        // Attachment 1
        FileSystemResource file1 = new FileSystemResource(new File(path1));
        helper.addAttachment("Txt file", file1);

        // Attachment 2
        FileSystemResource file2 = new FileSystemResource(new File(path2));
        helper.addAttachment("Readme", file2);

        emailSender.send(message);

        return "Email Sent!";
    }

}

6. Gửi email định dạng HTML

HtmlEmailExampleController.java

package org.o7planning.sbmail.controller;

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

import org.o7planning.sbmail.MyConstants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class HtmlEmailExampleController {

    @Autowired
    public JavaMailSender emailSender;

    @ResponseBody
    @RequestMapping("/sendHtmlEmail")
    public String sendHtmlEmail() throws MessagingException {

        MimeMessage message = emailSender.createMimeMessage();

        boolean multipart = true;
        
        MimeMessageHelper helper = new MimeMessageHelper(message, multipart, "utf-8");
        
        String htmlMsg = "<h3>Im testing send a HTML email</h3>"
                +"<img src='http://www.apache.org/images/asf_logo_wide.gif'>";
        
        message.setContent(htmlMsg, "text/html");
        
        helper.setTo(MyConstants.FRIEND_EMAIL);
        
        helper.setSubject("Test send HTML email");
        
    
        this.emailSender.send(message);

        return "Email Sent!";
    }

}