Spring Boot项目发送邮件教程
AI 摘要鱼粮不足,AI 今天先歇着 · 正文在下面
前言
发送邮件是现在许多网站都会有的功能之一,例如注册验证、忘记密码、推送营销信息等。
最早期的Java项目使用JavaMail相关api来写发送邮件的相关代码,配置繁琐,后来Spring推出了JavaMailSender更加简化了邮件发送的过程,在之后的Spring Boot对此封装了现在的spring-boot-starter-mail
教程
本文环境介绍:
jdk1.8 + Maven + SpringBoot2.7.4 + QQ邮箱
将介绍四种发生方式:
简单文本邮件、带附件邮件、邮件正文带图片、使用Themeleaf构建邮件模板。
1、引入依赖
在pom包里面添加spring-boot-starter-mail包引用
xml
<!--spring邮件依赖-->
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.4</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>spring-email</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring-email</name>
<description>spring-email</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<!--web依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--spring邮件依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-configuration2</artifactId>
<version>2.3</version>
</dependency>
<!--spring thymeleaf模版引擎-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</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>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>
2、在配置文件中添加邮箱配置
yaml
spring:
#注意:host 通道个人邮箱和企业邮箱通道不同。163的个人邮箱:smtp.163.com ,企业邮箱:smtp.qiye.163.com
# 腾讯的,个人smtp.qq.com, 企业的:smtp.exmail.qq.com
mail:
host: smtp.qq.com
username: xxxxx #邮箱
password: xxxxx #授权码
port: 465
default-encoding: UTF-8
properties:
mail:
smtp:
auth: true
socketFactory:
class: javax.net.ssl.SSLSocketFactory
starttls:
enable: true
# 开启debug,方便查看邮件发送日志
debug: true
3、发送邮件
3.1、定义接口IMailService
java
/**
* 邮件服务
*
* @author Salmon
* @date 2022/9/28 15:36
*/
public interface IMailService {
/**
* 发送简单文本邮件
*
* @param mailFrom 发送方邮箱
* @param mailFromNick 发送方昵称
* @param mailTo 接收方邮箱
* @param cc 抄送方邮箱(可为null)
* @param subject 邮件主题(标题)
* @param content 内容
*/
void sendSimpleMail(String mailFrom, String mailFromNick, String mailTo, String cc, String subject, String content);
/**
* 发送带附件的邮件
*
* @param mailFrom 发送方邮箱
* @param mailFromNick 发送方昵称
* @param mailTo 接收方邮箱
* @param cc 抄送方邮箱(可为null)
* @param subject 邮件主题(标题)
* @param content 内容
* @param files 附件
*/
void sendMailWithAttachments(String mailFrom, String mailFromNick, String mailTo, String cc, String subject, String content,
List<File> files);
/**
* 发送正文内容带图片的邮件
*
* @param mailFrom 发送方邮箱
* @param mailFromNick 发送方昵称
* @param mailTo 接收方邮箱
* @param cc 抄送方邮箱(可为null)
* @param subject 邮件主题(标题)
* @param content 内容
* @param imagePaths 图片路径
* @param imageId 图片ID
*/
void sendMailWithImage(String mailFrom, String mailFromNick, String mailTo, String cc, String subject, String content,
String[] imagePaths, String[] imageId);
/**
* 使用Thymeleaf构建邮件模板
*
* @param mailFrom 发送方邮箱
* @param mailFromNick 发送方昵称
* @param mailTo 接收方邮箱
* @param cc 抄送方邮箱(可为null)
* @param subject 邮件主题(标题)
* @param content 内容
*/
void sendHtmlMailThymeLeaf(String mailFrom, String mailFromNick, String mailTo, String cc, String subject, String content);
}
3.2、定义实现类EmailServiceImpl
java
/**
* 邮件服务
*
* @author Salmon
* @date 2022/9/28 15:37
*/
@Service
@Slf4j
public class MailServiceImpl implements IMailService {
@Autowired
private JavaMailSender mailSender;
/**
* 简单文本邮件
*
* @param mailFrom 发送方邮箱
* @param mailFromNick 发送方昵称
* @param mailTo 接收方邮箱
* @param cc 抄送方邮箱(可为null)
* @param subject 邮件主题(标题)
* @param content 内容
*/
@Override
public void sendSimpleMail(String mailFrom, String mailFromNick, String mailTo, String cc, String subject, String content) {
try {
// 多个收件人之间用英文逗号分隔
String[] mailToArr = mailTo.split(",");
for (String address : mailToArr) {
// 简单邮件信息类
MimeMessage mimeMessage = mailSender.createMimeMessage();
// HTML邮件信息类
MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage);
// 昵称
mimeMessageHelper.setFrom(new InternetAddress(mailFromNick + " <" + mailFrom + ">"));
mimeMessageHelper.setTo(address);
if (!StringUtils.isEmpty(cc)) {
mimeMessageHelper.setCc(cc);
}
mimeMessageHelper.setSubject(subject);
mimeMessageHelper.setText(content);
mailSender.send(mimeMessage);
}
} catch (MessagingException e) {
log.error("发送邮件失败", e);
}
}
/**
* 发送带附件的邮件
*
* @param mailFrom 发送方邮箱
* @param mailFromNick 发送方昵称
* @param mailTo 接收方邮箱
* @param cc 抄送方邮箱(可为null)
* @param subject 邮件主题(标题)
* @param content 内容
* @param files 附件
*/
@Override
public void sendMailWithAttachments(String mailFrom, String mailFromNick, String mailTo, String cc, String subject, String content, List<File> files) {
MimeMessage mimeMessage = mailSender.createMimeMessage();
try {
/*
第二个参数true表示构造一个multipart message类型的邮件,multipart message类型的邮件包含多个正文、附件以及内嵌资源,
邮件的表现形式更丰富
*/
MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
mimeMessageHelper.setFrom(new InternetAddress(mailFromNick + " <" + mailFrom + ">"));
mimeMessageHelper.setSubject(subject);
mimeMessageHelper.setText(content);
// 设置多个收件人
String[] toAddress = mailTo.split(",");
mimeMessageHelper.setTo(toAddress);
if (!StringUtils.isEmpty(cc)) {
mimeMessageHelper.setCc(cc);
}
// 添加附件
if (null != files) {
for (File file : files) {
// 通过addAttachment方法添加附件
mimeMessageHelper.addAttachment(file.getName(), file);
}
}
//发送邮件
mailSender.send(mimeMessage);
} catch (MessagingException e) {
log.error("发送邮件失败", e);
}
}
/**
* 发送正文内容带图片的邮件
*
* @param mailFrom 发送方邮箱
* @param mailFromNick 发送方昵称
* @param mailTo 接收方邮箱
* @param cc 抄送方邮箱(可为null)
* @param subject 邮件主题(标题)
* @param content 内容
* @param imagePaths 图片路径
* @param imageId 图片ID
*/
@Override
public void sendMailWithImage(String mailFrom, String mailFromNick, String mailTo, String cc, String subject, String content, String[] imagePaths, String[] imageId) {
MimeMessage mimeMessage = mailSender.createMimeMessage();
try {
MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
mimeMessageHelper.setFrom(new InternetAddress(mailFromNick + " <" + mailFrom + ">"));
// 设置多个收件人
String[] toAddress = mailTo.split(",");
mimeMessageHelper.setTo(toAddress);
if (!StringUtils.isEmpty(cc)) {
mimeMessageHelper.setCc(cc);
}
mimeMessageHelper.setSubject(subject);
// 第二个参数为true表示邮件正文是html格式的,默认是false
mimeMessageHelper.setText(content, true);
// 添加图片
if (imagePaths != null && imagePaths.length != 0) {
for (int i = 0; i < imagePaths.length; i++) {
// 通过FileSystemResource构造静态资源
FileSystemResource fileSystemResource = new FileSystemResource(imagePaths[i]);
// 调用addInline方法将资源加入邮件对象中
mimeMessageHelper.addInline(imageId[i], fileSystemResource);
}
}
//发送邮件
mailSender.send(mimeMessage);
} catch (MessagingException e) {
log.error("发送邮件失败", e);
}
}
/**
* 使用Thymeleaf构建邮件模板
*
* @param mailFrom 发送方邮箱
* @param mailFromNick 发送方昵称
* @param mailTo 接收方邮箱
* @param cc 抄送方邮箱(可为null)
* @param subject 邮件主题(标题)
* @param content 内容
*/
@Override
public void sendHtmlMailThymeLeaf(String mailFrom, String mailFromNick, String mailTo, String cc, String subject, String content) {
MimeMessage mimeMessage = mailSender.createMimeMessage();
try {
MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
mimeMessageHelper.setFrom(new InternetAddress(mailFromNick + " <" + mailFrom + ">"));
// 设置多个收件人
String[] toAddress = mailTo.split(",");
mimeMessageHelper.setTo(toAddress);
if (!StringUtils.isEmpty(cc)) {
mimeMessageHelper.setCc(cc);
}
mimeMessageHelper.setSubject(subject);
// 第二个参数为true表示邮件正文是html格式的,默认是false
mimeMessageHelper.setText(content, true);
mailSender.send(mimeMessage);
} catch (MessagingException e) {
System.out.println(e);
}
}
}
3.3、定义Thymeleaf邮件模版
模版文件默认存放在resources/templates目录下,本文模版名称为mailTemplate01.html,内容如下:
html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h2>
通过ThymeLeaf发送html邮件
</h2>
<table border="1">
<tr>
<td>用户名</td>
<!--使用th,html标签内要导入xmlns:th="http://www.thymeleaf.org"-->
<td th:text="${username}"></td>
</tr>
<tr>
<td>年龄</td>
<td th:text="${age}"></td>
</tr>
</table>
<div>
这是一张图片:
</div>
<div>
<img src="https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fpic1.win4000.com%2Fwallpaper%2F8%2F549cf5201acb9.jpg&refer=http%3A%2F%2Fpic1.win4000.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=auto?sec=1666952751&t=5b478bd41611ca1c55ad6859ac0aa17e"/>
</div>
</body>
</html>
ps:想学习使用Thymeleaf模板语法的同学,可以在本站搜索相关学习教程文章哦。
3.4、编写单元测试类
java
@SpringBootTest
@Slf4j
class SpringEmailApplicationTests {
@Autowired
private IMailService mailService;
@Value("${spring.mail.username}")
//发送方,注意要与配置文件的邮箱一致
private String mailFrom;
//接收方
private final String mailTo = "1179732961@qq.com";
//抄送方
private final String cc = "";
/**
* 1、测试普通邮件发送
*/
@Test
public void testSendSimpleMail() {
String result = "发送邮件成功";
try {
mailService.sendSimpleMail(mailFrom, "Salmon", mailTo, cc, "TestMail", "Hello World !");
} catch (Exception e) {
result = "发送邮件失败!";
log.error(result, e);
}
log.info(result);
}
/**
* 2、测试带附件的方法
*/
@Test
public void testSendAttachment() {
File imgFile = new File("/Users/chenxiangwen/Downloads/logo.png");
File txtFile = new File("/Users/chenxiangwen/Downloads/logo.png/03.md");
List<File> fileList = new ArrayList<>();
fileList.add(imgFile);
fileList.add(txtFile);
String result = "发送邮件成功";
try {
mailService.sendMailWithAttachments(mailFrom, "Salmon", mailTo, cc, "TestMail", "Hello World !", fileList);
} catch (Exception e) {
result = "发送邮件失败!";
log.error(result, e);
}
log.info(result);
}
/**
* 3、正文带图片
*/
@Test
public void testSendMailWithImage() {
// 图片路径
String image01Path = "/Users/chenxiangwen/Downloads/logo.png";
String image02Path = "/Users/chenxiangwen/Downloads/blog-logo.png";
String[] imageArr = new String[]{image01Path, image02Path};
String[] imageIdArr = new String[]{"image01", "image02"};
String result = "发送邮件成功";
try {
String contentHtml = "这是图片1:<div><img src='cid:image01'/></div>" +
"这是图片2:<div><img src='cid:image02'/></div>";
mailService.sendMailWithImage(mailFrom, "Salmon", mailTo, cc, "TestMail", contentHtml, imageArr, imageIdArr);
} catch (Exception e) {
result = "发送邮件失败!";
log.error(result, e);
}
log.info(result);
}
/**
* 4、使用ThymeLeaf
*/
// 注入TemplateEngine
@Autowired
TemplateEngine templateEngine;
@Test
public void testSendHtmlMailThymeLeaf() {
// 注意导入的包是org.thymeleaf.context
Context context = new Context();
context.setVariable("username", "萌新");
context.setVariable("age", "18");
String content = templateEngine.process("mailTemplate01.html", context);
mailService.sendHtmlMailThymeLeaf(mailFrom, "Salmon", mailTo, cc, "TestMail", content);
log.info("邮件发送成功");
}
}
3.5、测试
可以看到我们完成邮件发送啦

3.6、补充
忘记和大家说下怎么让邮箱开启SMTP服务,在这里说一下
- 首先点击邮箱设置

- 选择账户

- 开启smtp服务,按照提示步骤,生成授权码,这里任选一个开启即可

评论
1 条
番薯2022-10-01
大佬!好厉害!看完瞬间懂了