Spring Boot 发送邮件全解析

 

1.前言

欢迎阅读 Spring Boot 2 实战系列 电子邮件虽然近几年有点“退火”，但是在开发中依然有举足轻重的地位。在比较正式的场合我们依然通过电子邮件来传递信息和回执。今天我们就来学一下如何在 Spring Boot 下发送电子邮件。

2. 依赖

Java 发送邮件依赖 jakarta 项目（原 javaEE）提供的 jakarta.mail组件, Maven 坐标：

1. <dependency>

2. <groupId>com.sun.mail</groupId>

3. <artifactId>jakarta.mail</artifactId>

4. <version>1.6.4</version>

5. <scope>compile</scope>

6. </dependency>

Spring 官方 又将其进行进一步封装成开箱即用的 spring-boot-starter-mail 项目：

1. <dependency>

2. <groupId>org.springframework.boot</groupId>

3. <artifactId>spring-boot-starter-mail</artifactId>

4. </dependency>

在 Spring Boot 项目中我们引入上面的 spring-boot-starter-mail依赖即可为你的项目集成邮件功能。接下来我们来对邮件功能进行参数配置。

3. 邮箱配置

spring-boot-starter-mail 的配置由 MailProperties 配置类提供。在 application.yml 配置文件中以 spring.mail 为前缀。我们来看看都有哪些配置项。

1. # 字符集编码 默认 UTF-8

2. spring.mail.default-encoding=UTF-8

3. # SMTP 服务器 host qq邮箱的为 smtp.qq.com 端口 465 587

4. spring.mail.host=smtp.qq.com

5. # SMTP 服务器端口 不同的服务商不一样

6. spring.mail.port=465

7. # SMTP 服务器使用的协议

8. spring.mail.protocol=smtp

9. # SMTP服务器需要身份验证 所以 要配置用户密码

10.  

11. # 发送端的用户邮箱名

12. spring.mail.username=business@felord.cn

13. # 发送端的密码 注意保密

14. spring.mail.password=oooooxxxxxxxx

15. # 指定mail会话的jndi名称 优先级较高 一般我们不使用该方式

16. spring.mail.jndi-name=

17. # 这个比较重要 针对不同的SMTP服务器 都有自己的一些特色配置该属性 提供了这些配置的 key value 封装方案 例如 Gmail SMTP 服务器超时配置 spring.mail.properties.mail.smtp.timeout= 5000

18. spring.mail.properties.<key> =

19. # 指定是否在启动时测试邮件服务器连接，默认为false

20. spring.mail.test-connection=false

针对不同的邮箱有不同的配置，所以我们介绍几种我们常用的邮箱配置，可以直接拿来配置。

但是请注意很多邮箱需要手动开启 SMTP 功能，请务必确保该功能打开。如果在公有云上部署请避免使用 25 端口。

3.1