SpringBoot JavaMailSender 发送邮件

本文已参与「新人创作礼」活动，一起开启掘金创作之路。
Spring 提供了非常好用的 JavaMailSender 接口实现邮件发送。在 SpringBoot 的 Starter 模块中也为此提供了自动化配置。下面通过实例看看如何在 SpringBoot 中使用 JavaMailSender 发送邮件。
一、使用 SpringBoot 创建 Java Web 项目，添加邮件相关依赖包

在 SpringBoot 工程中的 pom.xml 中引入 spring-boot-starter-mail 依赖。
<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-mail</artifactId>
</dependency>
  由于 SpringBoot 的 starter 模块提供了自动化配置，所以在引入了 spring-boot-starter-mail 依赖之后，会根据配置文件 application.properties 中的内容去创建 JavaMailSender 实例，因此我们可以直接在需要使用的地方通过 @Autowired 来引入邮件发送对象 JavaMailSender。
二、 application.properties 配置邮件相关内容
  有些服务器没有网络代理，而有些服务器（例如生产环境）可能有 SMTP 邮件代理服务器，以下分别总结下有无代理服务器时的邮件相关配置。
  2.1 邮件配置（无代理）
spring.mail.host=此处填写邮件服务器
# SMTP 协议端口
spring.mail.port=465
spring.mail.username=此处填写发件箱
# 465 端口是 SSL 协议端口（非 SSL 协议端口是 25），还需要配置 SSL 协议相关内容
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
spring.mail.properties.mail.smtp.ssl.enable=true
# 若开启服务端校验身份，需要设置如下 2 项参数。如不开启校验则无需设置。
spring.mail.password=发件箱密码
spring.mail.properties.mail.smtp.auth=true
  2.2 邮件配置（有代理）
# 此处填写代理服务器地址（此处配置的代理服务器地址是一个假 IP）
spring.mail.host=4.4.4.4
# 此处填写代理服务器端口（此处配置的代理服务器端口是一个假端口）
spring.mail.port=1089
# 发送邮件协议
spring.mail.protocol=smtp
spring.mail.username=[your email username]
spring.mail.properties.mail.smtp.timeout=25000
spring.mail.properties.mail.smtp.socketFactory.port=465
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
spring.mail.properties.mail.smtp.ssl.enable=true
spring.mail.properties.mail.debug=true
spring.mail.password=[email password]
spring.mail.properties.mail.smtp.auth=true
  备注：有些邮件服务器的密码不是填真实的邮箱密码，而是授权码。如 QQ 邮箱等。
三、发送邮件代码示例
  3.1 发送简单邮件示例
package com.demo.mail.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MailController {
    private static Logger log = LoggerFactory.getLogger(MailController.class);
    @Autowired
    private JavaMailSender mailSender;
    // 发件箱（这是一个假的发件箱）
    private static String MAIL_FROM = "test@test.com";
    // 收件箱（这是一个假的收件箱）
    private static String MAIL_TO = "test@test.com";
     * 发送简单邮件
    @RequestMapping("sendSimpleMail")
    public String sendSimpleMail() {
        SimpleMailMessage message = new SimpleMailMessage();
        // 发件箱
        message.setFrom(MAIL_FROM);
        // 收件箱可以是多个，用 String[] 表示多个收件箱
        message.setTo(MAIL_TO);
        // 邮件主题
        message.setSubject("主题：发送简单邮件");
        // 邮件正文
        message.setText("测试简单邮件内容");
        try {
            mailSender.send(message);
            return "success";
        } catch (Exception e) {
            log.error("发送简单邮件异常", e);
            return "failure";
  3.2 发送 HTML 格式的邮件
package com.demo.mail.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.mail.internet.MimeMessage;
@RestController
public class MailController {
    private static Logger log = LoggerFactory.getLogger(MailController.class);
    @Autowired
    private JavaMailSender mailSender;
    // 发件箱（这是一个假的收件箱）
    private static String MAIL_FROM = "test@test.com";
    // 收件箱（这是一个假的收件箱）
    private static String MAIL_TO = "test@test.com";
     * 发送 HTML 格式的邮件
     * @return 邮件发送结果（成功：success；失败：failure）
    @RequestMapping("/sendHtmlMail")
    public String sendHtmlMail() {
        try {
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true, "UTF-8");
            helper.setFrom(MAIL_FROM);
            helper.setTo(MAIL_TO);
            helper.setSubject("主题：发送 html 内容");
            StringBuffer sb = new StringBuffer();
            sb.append("<h1>大标题</h1>")
                    .append("<p style='color:#F00'>红色字</p >")
                    .append("<p style='text-align:right'>右对齐</p >");
            helper.setText(sb.toString(), true);
            mailSender.send(mimeMessage);
            return "success";
        } catch (Exception e) {
            // 发送 html 邮件失败
            log.error("发送 html 邮件失败", e);
            return "failure";
  3.3 发送带附件的邮件
package com.demo.mail.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.mail.internet.MimeMessage;
import java.io.File;
@RestController
public class MailController {
    private static Logger log = LoggerFactory.getLogger(MailController.class);
    @Autowired
    private JavaMailSender mailSender;
    // 发件箱（这是一个假的收件箱）
    private static String MAIL_FROM = "test@test.com";
    // 收件箱（这是一个假的收件箱）
    private static String MAIL_TO = "test@test.com";
     * 发送带附件的邮件
     * @param file 文件地址及名称，如：/home/testuser/test.txt
     * @return 邮件发送结果（成功：success；失败：failure）
    @RequestMapping("/sendMailWithFile")
    public String sendMailWithFile(String file) {
        try {
            // 设置参数，不允许截断文件名，防止附件名乱码
            System.setProperty("mail.mime.splitlongparameters", "false");
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage, true, "UTF-8");
            messageHelper.setFrom(MAIL_FROM);
            messageHelper.setTo(MAIL_TO);
            messageHelper.setText("附件是测试文本，请查收。如有问题请与发件人联系。");
            messageHelper.setSubject("主题：周报测试文本");
            messageHelper.addAttachment("test.txt", new File(file));
            // 附件可以添加多个
            messageHelper.addAttachment("test1.txt", new File(file));
            mailSender.send(mimeMessage);
            return "success";
        } catch (Exception e) {
            // 发送邮件失败
            log.error("发送带附件的邮件失败", e);
            return "failure";
  3.4 发送嵌入静态资源的邮件
  有一种邮件是通过嵌入图片等静态资源，可以在正文中直接看到图片，而不用从附近中查看具体的图片，下面是实现代码。
package com.demo.mail.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.mail.internet.MimeMessage;
import java.io.File;
@RestController
public class MailController {
    private static Logger log = LoggerFactory.getLogger(MailController.class);
    @Autowired
    private JavaMailSender mailSender;
    // 发件箱（这是一个假的收件箱）
    private static String MAIL_FROM = "test@test.com";
    // 收件箱（这是一个假的收件箱）
    private static String MAIL_TO = "test@test.com";
     * 发送嵌入静态资源的邮件，正文中可以直接看到图片，而不用从附件中查看具体图片
     * @param imgFile 文件地址及名称，如：/home/testuser/test.png
     * @return 邮件发送结果（成功：success；失败：failure）
    @RequestMapping("/sendResourceMail")
    public String sendResourceMail(String imgFile) {
        try {
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true, "UTF-8");
            helper.setFrom(MAIL_FROM);
            helper.setTo(MAIL_TO);
            helper.setSubject("主题：发送静态资源邮件");
            helper.setText("<html><body>< img src=\"cid:hello\"></body></html>", true);
            // 注意：addInline() 中的资源名称 hello 必须与 text 正文中 cid:hello 对应起来
            FileSystemResource file = new FileSystemResource(new File(imgFile));
            helper.addInline("hello", file);
            mailSender.send(mimeMessage);
            return "success";
        } catch (Exception e) {
            // 发送嵌入静态资源的邮件失败
            log.error("发送静态资源邮件失败", e);
            return "failure";
复制代码