SpringBoot集成郵件服務

Spring Email 抽象的核心是 MailSender 接口，MailSender 的實現能夠把 Email 發送給郵件服務器，由郵件服務器實現郵件發送的功能。

Spring 自帶了一個 MailSender 的實現 JavaMailSenderImpl，它會使用 JavaMail API 來發送 Email。Spring 或 SpringBoot 應用在發送 Email 之前，我們必須要 JavaMailSenderImpl 裝配爲 Spring 應用上下文的一個 bean

項目結構圖

開始搭建

pom.xml 中增加對應的依賴

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

<!-- 我使用了lombok  -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>

配置文件修改，增加 mail 使用的配置信息

 application.properties

# QQ 郵箱 的host 爲 smtp.qq.com, 網易的爲 smtp.163.com
spring.mail.host=smtp.qq.com
[email protected]
spring.mail.password= 這裏輸入自己的編碼
spring.mail.default-encoding=utf-8

新建一個用於郵件發送的 Mail Bean

import lombok.Data;
import org.springframework.core.io.FileSystemResource;
import java.util.List;
@Data
public class Mail {

    private String[] to;    /*收件人列表*/
    private String subject; /*郵件主題*/
    private String text;    /*郵件內容*/
   private List<FileSystemResource> file;    /*附件*/

    /**
     * 內容ID，用於發送靜態資源郵件時使用
     */
    private String contentId;

    public static Mail getMail() {
        return new Mail();
    }

}

 增加一個用於發送郵件的工具類 EmailUtils.java

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Component;

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

/**
 * 發送郵件工具
 *
 * @author wuq
 * @create 2019-04-06 15:24
 */
@Component
public class EmailUtils {

    @Autowired
    private JavaMailSender mailSender; // 自動注入的Bean

    @Value("${spring.mail.username}")
    private String sender; // 讀取配置文件中的參數

    /**
     * 發送簡易郵件
     *
     * @param mail
     */
    public void sendMail(Mail mail) {
        MimeMessage mimeMessage = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage);

        try {
            helper.setFrom(sender);
            helper.setTo(mail.getTo());
            helper.setSubject(mail.getSubject());
            helper.setText(mail.getText());

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

    /**
     * 發送郵件-郵件正文是HTML
     *
     * @param mail
     */
    public void sendMailHtml(Mail mail) {
        MimeMessage mimeMessage = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage);

        try {
            helper.setFrom(sender);
            helper.setTo(mail.getTo());
            helper.setSubject(mail.getSubject());
            helper.setText(mail.getText(), true);

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

    /**
     * 發送郵件-附件郵件
     *
     * @param mail
     */
    public void sendMailAttachment(Mail mail) {
        try {
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
            helper.setFrom(sender);
            helper.setTo(mail.getTo());
            helper.setSubject(mail.getSubject());
            helper.setText(mail.getText(), true);

            // 增加附件名稱和附件
            for (FileSystemResource file : mail.getFile()) {
                helper.addAttachment(file.getFilename(), file);
            }
            mailSender.send(mimeMessage);
        } catch (MessagingException e) {
            e.printStackTrace();
        }
    }

    /**
     * 內聯資源（靜態資源）郵件發送
     * 由於郵件服務商不同，可能有些郵件並不支持內聯資源的展示
     * 在測試過程中，新浪郵件不支持，QQ郵件支持
     * 不支持不意味着郵件發送不成功，而且內聯資源在郵箱內無法正確加載
     * 發送的內容格式還是 html 模式
     *
     * @param mail
     */
    public void sendMailInline(Mail mail) {
        try {
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
            helper.setFrom(sender);
            helper.setTo(mail.getTo());
            helper.setSubject(mail.getSubject());

            /*
             * 內聯資源郵件需要確保先設置郵件正文，再設置內聯資源相關信息
             */

            // todo 只是測試發送一個圖片
            helper.setText(mail.getText(), true);
            helper.addInline(mail.getContentId(), mail.getFile().get(0));

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

    /**
     * 模板郵件發送
     *
     * @param mailBean
     */
    public void sendMailTemplate(Mail mailBean) {
        try {
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
            helper.setFrom(sender);
            helper.setTo(mailBean.getTo());
            helper.setSubject(mailBean.getSubject());
            helper.setText(mailBean.getText(), true);
            mailSender.send(mimeMessage);
        } catch (MessagingException e) {
            e.printStackTrace();
        }
    }

}

 測試類

import com.study.demo.framework.utils.email.EmailUtils;
import com.study.demo.framework.utils.email.Mail;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.core.io.FileSystemResource;
import org.springframework.test.context.junit4.SpringRunner;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

/**
 * 郵件測試
 *
 * @author wuq
 * @create 2019-04-10 19:29
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class EmailDemoTest {

    @Autowired
    EmailUtils emailUtils;

    @Test
    public void contextLoads() {
        Mail mail = Mail.getMail();
        mail.setSubject("SpringBoot集成JavaMail實現郵件發送");
        mail.setText("SpringBoot集成JavaMail實現簡易郵件發送功能");

        String[] toList = {"[email protected]"};
        mail.setTo(toList);
        emailUtils.sendMail(mail);
    }


    @Test
    public void sendHTML(){
        Mail mail = Mail.getMail();
        mail.setSubject("SpringBoot集成JavaMail實現郵件發送");

        String[] toList = {"[email protected]"};
        mail.setTo(toList);

        String content = "<!DOCTYPE html>\n" +
                "<html>\n" +
                "<body>\n" +
                "\t<h3>這是由 spring boot 集成 mail 發送的 html 郵件</h3>\n" +
                "</body>\n" +
                "</html>";
        mail.setText(content);

        emailUtils.sendMailHtml(mail);
    }

    @Test
    public void sendAttarchment(){
        Mail mail = Mail.getMail();
        mail.setSubject("SpringBoot集成JavaMail實現郵件發送");
        mail.setText("SpringBoot集成JavaMail實現簡易郵件發送功能");

        String[] toList = {"[email protected]"};
        mail.setTo(toList);

        List<FileSystemResource> list = new ArrayList<>();
        list.add(new FileSystemResource(new File("E:\\test\\img\\150A01.png")));
        list.add(new FileSystemResource(new File("E:\\test\\img\\150A01.png")));
        mail.setFile(list);

        emailUtils.sendMailAttachment(mail);
    }

    @Test
    public void sendImg(){
        Mail mail = Mail.getMail();
        mail.setSubject("SpringBoot集成JavaMail實現郵件發送");
        String[] toList = {"[email protected]"};
        mail.setTo(toList);

        // 設置圖片的地址名稱
        String contentId = "0001";

        String content = "<!DOCTYPE html>\n" +
                "<html>\n" +
                "<body>\n" +
                "\t<h3>這是由 spring boot 集成 mail 發送的 html 郵件</h3>\n" +
                " <div> <img src=\'cid:"+contentId+"\' /> </div> " +
                "</body>\n" +
                "</html>";
        mail.setText(content);
        mail.setContentId(contentId);

        // 添加附件
        List<FileSystemResource> list = new ArrayList<>();
        list.add(new FileSystemResource(new File("E:\\test\\img\\150A01.png")));
        mail.setFile(list);

        emailUtils.sendMailInline(mail);
    }
}

這裏測試的是第一個方法，在郵箱中查看