SpringBoot+mail 轻松实现各类邮件自动推送
一、简介
在实际的项目开发过程中，经常需要用到邮件通知功能。例如，通过邮箱注册，邮箱找回密码，邮箱推送报表等等，实际的应用场景非常的多。
早期的时候，为了能实现邮件的自动发送功能，通常会使用 JavaMail 相关的 api 来完成。后来 Spring 推出的 JavaMailSender 工具，进一步简化了邮件的自动发送过程，调用其 send 方法即可发送邮件。再之后， Spring Boot 针对邮件推送功能推出了spring-boot-starter-mail工具包，开发者可以通过它来快速实现邮件发送服务。
今天通过这篇文章，我们一起来学习如何在 Spring Boot 中快速实现一个自动发送邮件的功能。
二、环境准备
在介绍邮件推送实现之前，我们需要先准备一台邮件推送的服务器，以便实现相关功能。
这里以腾讯邮箱为例，将其作为邮件发送的中转平台。
2.1、开启 SMTP 服务
登陆腾讯邮箱，打开【设置】-》【收发信设置】，开启 SMTP 服务，最后点击【保存更改】。
2.2、生成客户端专用密码
点击【设置】-》【账户】，进入页面后点击【开启安全登陆】，点击【生成新密码】。
这个新密码会用于邮箱的自动发送，因此需要记录下来，最后点击【保存更改】。
2.3、相关扩展知识
- 什么是 SMTP？
SMTP（simple mail transfer protocol），也被称为简单邮件传输协议，主要用于发送电子邮件的，通过它可以实现邮件的发送或者中转。遵循 SMTP 协议的服务器，通常称为发送邮件服务器。
- 什么是 POP3？
POP3（Post Office Protocol），一种邮局通信协议。主要用于接受电子邮件的，POP3 允许用户从服务器上把邮件存储到自己的计算机上，同时删除保存在邮件服务器上的邮件。同理，遵循 POP3 协议的服务器，通常称为接收邮件服务器。
- 什么是 IMAP？
IMAP（Internet Mail Access Protocol），一种交互式邮件存取协议。与 POP3 协议类似，主要用于接收电子邮件，稍有不同的是：IMAP 允许电子邮件客户端收取的邮件仍然保留在服务器上，同时在客户端上的操作都会反馈到服务器上，例如删除邮件，标记已读等，服务器上的邮件也会做相应的动作。所以无论从浏览器登录邮箱或者客户端软件登录邮箱，看到的邮件以及状态都是一致的。
总结下来就是：SMTP 负责发送邮件，POP3/IMAP 负责接收邮件。
常见邮箱发、收服务器如下！
三、邮件推送实现
用于发送邮件的服务器、账户和密码准备好了之后，就可以正式使用了。下面我们以 Spring Boot 的 2.1.0版本为基础，实现过程如下。
2.1、添加依赖包
在pom.xml文件中，添加spring-boot-starter-mail依赖包。
<!--mail 支持-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
2.2、添加相关配置
在application.properties中添加邮箱相关配置。
# 配置邮件发送主机地址
spring.mail.host=smtp.exmail.qq.com
# 配置邮件发送服务端口号
spring.mail.port=465
# 配置邮件发送服务协议
spring.mail.protocol=smtp
# 配置邮件发送者用户名或者账户
spring.mail.username=xxx@qq.com
# 配置邮件发送者密码或者授权码
spring.mail.password=xxxxxxx
# 配置邮件默认编码
spring.mail.default-encoding=UTF-8
# 配置smtp相关属性
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.ssl.enable=true
spring.mail.properties.mail.smtp.ssl.required=true
2.3、简单发送一封邮件
通过单元测试来实现一封简单邮件的发送，示例如下：
@RunWith(SpringRunner.class)
@SpringBootTest
public class MailSimpleTest {
@Autowired
private JavaMailSender mailSender;
@Test
public void sendSimpleMail() throws Exception {
SimpleMailMessage message = new SimpleMailMessage();
// 配置发送者邮箱
message.setFrom("xxxx@qq.com");
// 配置接受者邮箱
message.setTo("xxxxxx@qq.com");
// 配置邮件主题
message.setSubject("主题：简单邮件");
// 配置邮件内容
message.setText("测试邮件内容");
// 发送邮件
mailSender.send(message);
}
}
运行单元测试之后，如果不出意外的话，接受者会收到这样的一封邮件。
至此，邮件发送成功！
2.4、发送 HTML 格式邮件
在实际的业务开发中，邮件的内容通常会要求丰富，比如会发送一些带有图片的内容，包括字体大小，各种超链接等，这个时候如何实现呢？
实际上，邮件内容支持 HTML 格式，因此可以借助页面模板引擎来实现绚丽多彩的内容。
下面我们以freemarker模板引擎为例，发送一封内容为 HTML 格式的邮件。
2.4.1、引入 freemarker 依赖包
首先，在pom.xml文件中，添加freemarker依赖包。
<!--freemarker 支持-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.23</version>
</dependency>
2.4.2、编写邮件页面模板
然后，在resources/templates目录下，创建一个demo.ftl文件，示例如下！
<html>
<head>
<meta charset="utf-8">
<title></title>
</head>
<body>
<div>您好：${userName}</div>
<div>这是html文本内容</div>
<img src="https://rescdn.qqmail.com/zh_CN/htmledition/images/logo/logo_0_0@2X1f1937.png" />
</body>
</html>
2.4.3、编写一个邮件推送服务
虽然采用 Spring Boot 提供的自动配置属性来实现邮件推送，可以极大的简化开发过程。而实际开发的时候，通常更推荐自定义一个邮件统一推送服务，这样更便于灵活的控制代码实现以及排查相关问题。
邮件统一发送服务，示范如下。
@Component
public class MailPushService {
private final Logger LOGGER = LoggerFactory.getLogger(MailPushService.class);
@Value("${mail.host}")
private String host;
@Value("${mail.port}")
private String port;
@Value("${mail.protocol}")
private String protocol;
@Value("${mail.username}")
private String username;
@Value("${mail.password}")
private String password;
@Value("${mail.fromEmail}")
private String fromEmail;
@Value("${mail.fromPersonal}")
private String fromPersonal;
@Autowired
private JavaMailSender mailSender;
/**
* 发送邮件（简单模式）
* @param toEmail
* @param subject
* @param content
*/
public void sendMail(String toEmail, String subject,String content) {
try {
final Properties props = new Properties();
//服务器
props.put("mail.smtp.host", host);
//端口
props.put("mail.smtp.port", port);
//协议
props.setProperty("mail.transport.protocol", protocol);
//用户名
props.put("mail.user", username);
//密码
props.put("mail.password", password);
//使用smtp身份验证
props.put("mail.smtp.auth", "true");
//开启安全协议
MailSSLSocketFactory sf = new MailSSLSocketFactory();
sf.setTrustAllHosts(true);
props.put("mail.smtp.ssl.enable", "true");
props.put("mail.smtp.ssl.socketFactory", sf);
Authenticator authenticator = new Authenticator() {
@Override
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication(props.getProperty("mail.user"),
props.getProperty("mail.password"));
}
};
Session session = Session.getDefaultInstance(props, authenticator);
session.setDebug(true);
MimeMessage mimeMessage = new MimeMessage(session);
mimeMessage.setFrom(new InternetAddress(fromEmail, MimeUtility.encodeText(fromPersonal)));
mimeMessage.setRecipient(MimeMessage.RecipientType.TO, new InternetAddress(toEmail));
mimeMessage.setSubject(subject);
mimeMessage.setContent(content, "text/html;charset=UTF-8");
//保存信息
mimeMessage.saveChanges();
//发送消息
Transport.send(mimeMessage);
LOGGER.info("简单邮件已经发送。");
} catch (Exception e) {
LOGGER.error("发送简单邮件时发生异常！", e);
}
}
}
代码中相关自定义的全局参数配置如下：
mail.host=smtp.exmail.qq.com
mail.port=465
mail.protocol=smtp
mail.username=xxx@qq.com
mail.password=xxxxxx
mail.fromEmail=xxxxxx@qq.com
mail.fromPersonal=发送者昵称
2.4.4、测试服务的正确性
最后，编写一个单元测试来验证服务的正确性，示例如下：
@RunWith(SpringRunner.class)
@SpringBootTest
public class MailTest {
@Autowired
private MailPushService mailPushService;
@Test
public void testSendHtmlMail() throws Exception {
String sendHtml = buildHtmlContent("张三");
mailPushService.sendMail("xxxxx@qq.com","简单标题", sendHtml);
}
/**
* 封装html页面
* @return
* @throws Exception
*/
private static String buildHtmlContent(String userName) throws Exception {
Configuration configuration = new Configuration(Configuration.VERSION_2_3_23);
configuration.setDefaultEncoding(Charset.forName("UTF-8").name());
configuration.setClassForTemplateLoading(MailTest.class, "/templates");
// 获取页面模版
Template template = configuration.getTemplate("demo.ftl");
// 动态变量替换
Map<String,Object> map = new HashMap<>();
map.put("userName", userName);
String htmlStr = FreeMarkerTemplateUtils.processTemplateIntoString(template,map);
return htmlStr;
}
}
运行单元测试之后，如果没有报错，接受者会收到这样的一封邮件。
2.5、发送带附件的邮件
某些业务场景，用户希望发送的邮件中能带上附件，比如上文中，在发送 HTML 格式的邮件时，同时也带上文件附件，这个时候如何实现呢？
2.5.1、编写带附件的邮件发送
此时可以在邮件推送服务中，新增一个支持带附件的方法，实现逻辑如下。
/**
* 发送邮件（复杂模式）
* @param toEmail 接受者邮箱
* @param subject 主题
* @param sendHtml 内容
* @param attachment 附件
*/
public void sendMail(String toEmail, String subject, String sendHtml, File attachment) {
try {
//设置了附件名过长问题
System.setProperty("mail.mime.splitlongparameters", "false");
final Properties props = new Properties();
//服务器
props.put("mail.smtp.host", host);
//端口
props.put("mail.smtp.port", port);
//协议
props.setProperty("mail.transport.protocol", protocol);
//用户名
props.put("mail.user", username);
//密码
props.put("mail.password", password);
//使用smtp身份验证
props.put("mail.smtp.auth", "true");
//开启安全协议
MailSSLSocketFactory sf = new MailSSLSocketFactory();
sf.setTrustAllHosts(true);
props.put("mail.smtp.ssl.enable", "true");
props.put("mail.smtp.ssl.socketFactory", sf);
Authenticator authenticator = new Authenticator() {
@Override
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication(props.getProperty("mail.user"),
props.getProperty("mail.password"));
}
};
Session session = Session.getDefaultInstance(props, authenticator);
session.setDebug(true);
MimeMessage mimeMessage = new MimeMessage(session);
// 发送者邮箱
mimeMessage.setFrom(new InternetAddress(fromEmail, MimeUtility.encodeText(fromPersonal)));
// 接受者邮箱
mimeMessage.setRecipient(MimeMessage.RecipientType.TO, new InternetAddress(toEmail));
// 邮件主题
mimeMessage.setSubject(subject);
// 定义邮件内容
Multipart multipart = new MimeMultipart();
// 添加邮件正文
BodyPart contentPart = new MimeBodyPart();
contentPart.setContent(sendHtml, "text/html;charset=UTF-8");
multipart.addBodyPart(contentPart);
// 添加附件
if (attachment != null) {
BodyPart attachmentBodyPart = new MimeBodyPart();
// MimeUtility.encodeWord可以避免文件名乱码
FileDataSource fds=new FileDataSource(attachment);
attachmentBodyPart.setDataHandler(new DataHandler(fds));
attachmentBodyPart.setFileName(MimeUtility.encodeText(fds.getName()));
multipart.addBodyPart(attachmentBodyPart);
}
// 将multipart对象放到message中
mimeMessage.setContent(multipart);
//保存信息
mimeMessage.saveChanges();
//发送消息
Transport.send(mimeMessage);
LOGGER.info("邮件已经发送。");
} catch (Exception e) {
LOGGER.error("发送邮件时发生异常！", e);
}
}
2.5.2、测试服务的正确性
最后，编写一个单元测试来验证服务的正确性，示例如下：
@Test
public void doSendHtmlEmail() throws Exception {
// 获取正文内容
String sendHtml = buildHtmlContent("张三");
// 获取附件
File file = new File( "~/doc/Java开发手册.pdf");
// 发送邮件
mailPushService.sendMail("xxxxx@qq.com","带附件的邮件推送", sendHtml, file);
}
运行单元测试之后，如果没有报错，接受者会收到这样的一封邮件。
三、小结
最后总结一下，邮件自动推送功能在实际的业务系统中应用非常广，在发送过程中也可能会因为网络问题出现各种失败现象，因此推荐采用异步的方式来发送邮件，例如采用异步编程或者消息队列来实现，以便加快主流程的执行速度。
想要获取项目源代码的小伙伴，可以访问如下地址获取！
四、参考
1.https://blog.csdn.net/qq_26383975/article/details/121957917
1.http://www.ityouknow.com/springboot/2017/05/06/spring-boot-mail.html
SpringBoot+mail 轻松实现各类邮件自动推送的更多相关文章
- 百度自动推送js
<!DOCTYPE html> <!-- saved from url=(0014)about:internet --> <html> <head> & ...
- SEO教程:快速增加360搜索引擎收录，360自动推送批量推送版
上次改编了一下百度的JS推送代码,实现了批量推送 传送门>>>百度链接提交-js代码推送批量推送版 这次我们来研究360js自动推送代码. <script> (funct ...
- app后端设计(3)--短信，邮件，推送服务（2014.12.05更新）
在app的后端设计中,免不了消息的推送,短信,邮件等服务,下面就个人的开发经验谈谈这方面. (1)最重要的是,各种推送一定要放在队列系统中处理,不然会严重影响api的响应时间. (2)短信方面 以前我 ...
- dotnet core使用IO合并技巧轻松实现千万级消息推送
之前讲述过多路复用实现单服百万级别RPS吞吐,但在文中有一点是没有说的就是消息IO合并,如果缺少了消息IO合并即使怎样多路复用也很难达到百万级别的请求响毕竟所有应用层面的网络IO读写都是非常损耗性能的 ...
- fuel 6.1自动推送3控高可用centos 6.5 juno环境排错（一）
查看fuel日志: # less /var/log/docker-logs/remote/node-1.domain.tld/puppet-apply.log 2015-12-25T17:26:22. ...
- idea + springboot 的java后台服务器通过小米推送
public class XiaomiPush { // 1.小米推送(我只推送Android且只应用regId发起推送,所以下面只有推送Android的代码 private static final ...
- 微信消息自动推送(评论区有我改好的模板及exe一键推送文件)
方案1:腾讯云函数(企业ID+应用ID和密钥(发送密钥得下企业微信app)+自己云函数的IP固定IP详情方法在下图) 推荐使用多图,因为内容会显示的丰富(所有图片文字都可以自定义 都在评论区下面的模板 ...
- java结合email实现自动推送
1.获取表中最后一条数据 public static String demo() throws SQLException { String sql = "select * FROM baox ...
- 使用GitHub Action进行打包并自动推送至OSS
GitHub Action 是 GitHub 于 2018 年 10 月推出的一个 CI\CD 服务. 官方文档:https://docs.github.com/cn/actions CI\CD 持续 ...
- HTML5 SSE自动推送
前端页面: <!doctype html> <html> <head> <meta charset="UTF-8"> <tit ...
随机推荐
- 深入 Django 模型层：数据库设计与 ORM 实践指南
title: 深入 Django 模型层:数据库设计与 ORM 实践指南 date: 2024/5/3 18:25:33 updated: 2024/5/3 18:25:33 categories: ...
- 校园圈子系统前后端安装开发app小程序h5
四川掌上时代开发公司,作为一家专注于提供高质量软件解决方案的企业,在信息技术领域已经积累了丰富的经验和良好的声誉.位于中国四川省成都市,该公司不仅服务于本地市场,还将业务拓展到了全国乃至国际市场,与多 ...
- rails byebug
Gemfile里添加 gem 'byebug' bundle install 在要打断点的地方写 byebug byebug -h #帮助 c 放行,入下走 n 单行调适 q 退出进行 启动异步任务推 ...
- Golang 版本 支付宝支付SDK app支付接口2.0
参考技术贴: https://blog.csdn.net/ming2316780/article/details/86505883 对接文档: https://opendocs.alipay.com/ ...
- Linux中的cp命令
Linux中cp命令用来赋值文件或者目录,其常用的命令选项如下: 下面是cp命令的一些使用示例: 默认情况下,cp命令赋值出来的权限或者属性通常来源自操作者本身.比如上面在root身份在执行cp命令, ...
- SQL中常用的字符串REVERSE函数和SUBSTRING函数详解！
今天继续整理日常可能经常遇到的一些处理字符串的函数,记得点赞收藏!以备不时之需! REVERSE(expression)函数解析:SQL Server中的此函数用于反转(颠倒)指定的字符串,也就是说把 ...
- PCF 的 Npcf_PolicyAuthorization 服务化接口
目录 文章目录 目录 引用 前文列表 术语 PCF Npcf_PolicyAuthorization 服务化操作类型 服务化接口参数类型 创建 Application Session Context: ...
- Python：global、local与nonlocal变量
1 local和global变量 先来看一个最简单的Python程序例子: import numpy as np n = 2 def func(a): b = 1 return a + b print ...
- diffusion model(一)：DDPM技术小结 (denoising diffusion probabilistic)
发布日期:2023/05/18 主页地址:http://myhz0606.com/article/ddpm 1 从直觉上理解DDPM 在详细推到公式之前,我们先从直觉上理解一下什么是扩散 对于常规的生 ...
- mysql in不走索引可能的情况
在MySQL 5.7.3以及之前的版本中,eq_range_index_dive_limit的默认值为10,之 后的版本默认值为200.所以如果大家采用的是5.7.3以及之前的版本的话,很容易采用索引 ...