Java - SpringBoot借助Java Mail Sender(基于javax/jakarta.mail)发邮件

原创已于 2023-12-12 16:31:53 修改 · 2.5k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#java

于 2023-11-02 21:25:31 首次发布

Java 专栏收录该内容

34 篇文章

订阅专栏

本文介绍了SMTP和POP3协议在电子邮件系统中的作用，详细讲解了如何在Springboot项目中使用JavaMailSender发送简单邮件、带附件和HTML邮件，以及如何利用Thymeleaf创建和发送邮件模板。

邮件基础

SMTP 协议全称为 Simple Mail Transfer Protocol，译作简单邮件传输协议，它定义了邮件客户端软件与 SMTP 服务器之间，以及 SMTP 服务器与 SMTP 服务器之间的通信规则。

SMTP 是一个基于 TCP/IP 的应用层协议，有点类似于 HTTP，80端口，SMTP 服务器默认监听的端口号为 25 。

假设从 aaa@qq.com 发送邮件到 bbb@163.com ：

aaa@qq.com用户先将邮件投递到腾讯的邮件服务器
腾讯的邮件服务器将邮件投递到网易的邮件服务器
bbb@163.com用户登录网易的邮件服务器查看邮件

也就是说 aaa@qq.com 用户先将邮件投递到腾讯的 SMTP 服务器这个过程就使用了 SMTP 协议，然后腾讯的 SMTP 服务器将邮件投递到网易的 SMTP 服务器这个过程也依然使用了 SMTP 协议，SMTP 服务器就是用来收邮件。

而 POP3 协议全称为 Post Office Protocol ，译作邮局协议，它定义了邮件客户端与 POP3 服务器之间的通信规则

当邮件到达网易的 SMTP 服务器之后， bbb@163.com 用户需要登录服务器查看邮件。

邮件服务商会为每一个用户提供专门的邮件存储空间，SMTP 服务器收到邮件之后，就将邮件保存到相应用户的邮件存储空间中，如果用户要读取邮件，就需要通过邮件服务商的 POP3 邮件服务器来完成。

邮箱设置

如果直接在邮件服务商的页面操作自然无需额外操作。

现在我们需要在程序中发邮件，那就得先去账号中开启相应的服务：

首先到电子邮箱的设置页面开启SMTP，获得SMTP的服务器域名和端口号，成功开启后会获得服务密码，这个服务密码需要再程序中使用，用户验证身份，请将其记录下来。

引入依赖

Springboot项目中引入依赖：

I/O下的Java Mail Sender

pom文件中显示：

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

原javax包现改为了jakarta，如果是旧版本则是javax

配置文件

#配置 SMTP 服务器地址
spring.mail.host=smtp.163.com
#SMTP 服务器的端口
spring.mail.port=465
#配置邮箱用户名
spring.mail.username=********@163.com
#配置密码，注意，不是真正的密码，而是刚刚申请到的服务密码
spring.mail.password=*************
#默认的邮件编码
spring.mail.default-encoding=UTF-8
#配饰 SSL 加密工厂
spring.mail.properties.mail.smtp.socketFactoryClass=javax.net.ssl.SSLSocketFactory
#表示开启 DEBUG 模式，这样，邮件发送过程的日志会在控制台打印出来，方便排查错误
spring.mail.properties.mail.debug=true
#官方建议使用 465 端口，而 465 端口是 SSL 协议的，所以不仅要换端口，
#还需要进行 SSL 协议替换。下面是在 application.properties 进行的邮件发送相关配置，
spring.mail.protocol=smtp
spring.mail.properties.mail.smtp.ssl.enable=true
spring.mail.properties.mail.smtp.socketFactory.port=465

发送简单邮件

@Autowired
JavaMailSender javaMailSender;

@Test
public void sendSimpleMail() {
    SimpleMailMessage message = new SimpleMailMessage();
    message.setSubject("这是一封测试邮件");
    message.setFrom("xxx@163.com");
    message.setTo("xxx@qq.com");
    // message.setCc("xxx@qq.com"); // 普通抄送邮件接收者可以看到邮件都抄送给了哪些人
    // message.setBcc("xxx@qq.com"); // 盲抄送邮件接收者则看不到
    message.setSentDate(new Date());
    message.setText("这是测试邮件的正文");
    javaMailSender.send(message);
}

发送带附件的邮件

@Autowired
JavaMailSender javaMailSender;

@Test
public void sendAttachFileMail() throws MessagingException {
    MimeMessage mimeMessage = javaMailSender.createMimeMessage();
    MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
    helper.setSubject("这是一封测试邮件");
    helper.setFrom("xxx@163.com");
    helper.setTo("xxx@qq.com");
    // helper.setCc("xxx@qq.com");
    // helper.setBcc("xxx@qq.com");
    helper.setSentDate(new Date());
    helper.setText("这是测试邮件的正文");
    helper.addAttachment("测试图片.jpg", new File("C:\\Users\\Administrator\\Desktop\\1.jpg"));
    javaMailSender.send(mimeMessage);
}

发送HTML邮件

@Autowired
JavaMailSender javaMailSender;

@Test
public void sendImgResMail() throws MessagingException {
    MimeMessage mimeMessage = javaMailSender.createMimeMessage();
    MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
    helper.setSubject("这是一封测试邮件");
    helper.setFrom("xxx@qq.com");
    helper.setTo("xxx@qq.com");
    helper.setCc("xxx@qq.com");
    // helper.setBcc("xxx@qq.com");
    // helper.setSentDate(new Date());
    helper.setText("<p>hello 大家好，这是一封测试邮件，这封邮件包含两种图片，分别如下</p><p>第一张图片：</p><img src='cid:p01'/><p>第二张图片：</p><img src='cid:p02'/>", true);
    helper.addInline("p01", new FileSystemResource(new File("C:\\Users\\Administrator\\Desktop\\1.jpg")));
    helper.addInline("p02", new FileSystemResource(new File("C:\\Users\\Administrator\\Desktop\\2.jpg")));
    javaMailSender.send(mimeMessage);
}

这里的邮件 text 是一个 HTML 文本，里边涉及到的图片资源先用一个占位符占着

setText 方法的第二个参数 true 表示第一个参数是一个 HTML 文本。

setText 之后，再通过 addInline 方法来添加图片资源。

使用 Thymeleaf 作邮件模板发送HTML邮件

正常来说，邮件的内容都是比较的丰富的，所以大部分邮件都是通过 HTML 来呈现的，如果直接拼接 HTML 字符串，这样以后不好维护，为了解决这个问题，一般邮件发送，都会有相应的邮件模板。最具代表性的两个模板就是 Freemarker 模板和 Thyemeleaf 模板了

推荐在 Spring Boot 中使用 Thymeleaf 来构建邮件模板。因为 Thymeleaf 的自动化配置提供了一个 TemplateEngine，通过 TemplateEngine 可以方便的将 Thymeleaf 模板渲染为 HTML ，同时，Thymeleaf 的自动化配置在这里是继续有效的。

引入 Thymeleaf 依赖

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

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<p>hello 欢迎加入 xxx 大家庭，您的入职信息如下：</p>
<table border="1">
    <tr>
        <td>姓名</td>
        <td th:text="${username}"></td>
    </tr>
    <tr>
        <td>工号</td>
        <td th:text="${num}"></td>
    </tr>
    <tr>
        <td>薪水</td>
        <td th:text="${salary}"></td>
    </tr>
</table>
<div style="color: #ff1a0e">一起努力创造辉煌</div>
</body>
</html>

@Autowired
JavaMailSender javaMailSender;

@Autowired
TemplateEngine templateEngine;

@Test
public void sendThymeleafMail() throws MessagingException {
    MimeMessage mimeMessage = javaMailSender.createMimeMessage();
    MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
    helper.setSubject("这是一封测试邮件");
    helper.setFrom("xxx@163.com");
    helper.setTo("xxx@qq.com");
    // helper.setCc("xxx@qq.com");
    // helper.setBcc("xxx@qq.com");
    helper.setSentDate(new Date());
    Context context = new Context();
    context.setVariable("username", "javaboy");
    context.setVariable("num", "000001");
    context.setVariable("salary", "99999");
    String process = templateEngine.process("mail.html", context);
    helper.setText(process, true);
    javaMailSender.send(mimeMessage);
}

import org.thymeleaf.context.Context;