经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » Java相关 » Spring » 查看文章
SpringBoot+mail 轻松实现各类邮件自动推送
来源：cnblogs　　作者：潘志的研发笔记　　时间：2024/7/3 14:40:15　　对本文有异议

一、简介

在实际的项目开发过程中，经常需要用到邮件通知功能。例如，通过邮箱注册，邮箱找回密码，邮箱推送报表等等，实际的应用场景非常的多。

早期的时候，为了能实现邮件的自动发送功能，通常会使用 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依赖包。

  1. <!--mail 支持-->
  2. <dependency>
  3.     <groupId>org.springframework.boot</groupId>
  4.     <artifactId>spring-boot-starter-mail</artifactId>
  5. </dependency>

2.2、添加相关配置

在application.properties中添加邮箱相关配置。

  1. # 配置邮件发送主机地址
  2. spring.mail.host=smtp.exmail.qq.com
  3. # 配置邮件发送服务端口号
  4. spring.mail.port=465
  5. # 配置邮件发送服务协议
  6. spring.mail.protocol=smtp
  7. # 配置邮件发送者用户名或者账户
  8. spring.mail.username=xxx@qq.com
  9. # 配置邮件发送者密码或者授权码
  10. spring.mail.password=xxxxxxx
  11. # 配置邮件默认编码
  12. spring.mail.default-encoding=UTF-8
  13. # 配置smtp相关属性
  14. spring.mail.properties.mail.smtp.auth=true
  15. spring.mail.properties.mail.smtp.ssl.enable=true
  16. spring.mail.properties.mail.smtp.ssl.required=true

2.3、简单发送一封邮件

通过单元测试来实现一封简单邮件的发送，示例如下：

  1. @RunWith(SpringRunner.class)
  2. @SpringBootTest
  3. public class MailSimpleTest {
  5.     @Autowired
  6.     private JavaMailSender mailSender;
  8.     @Test
  9.     public void sendSimpleMail() throws Exception {
  10.         SimpleMailMessage message = new SimpleMailMessage();
  11.         // 配置发送者邮箱
  12.         message.setFrom("xxxx@qq.com");
  13.         // 配置接受者邮箱
  14.         message.setTo("xxxxxx@qq.com");
  15.         // 配置邮件主题
  16.         message.setSubject("主题：简单邮件");
  17.         // 配置邮件内容
  18.         message.setText("测试邮件内容");
  19.         // 发送邮件
  20.         mailSender.send(message);
  21.     }
  22. }

运行单元测试之后，如果不出意外的话，接受者会收到这样的一封邮件。

至此，邮件发送成功！

2.4、发送 HTML 格式邮件

在实际的业务开发中，邮件的内容通常会要求丰富，比如会发送一些带有图片的内容，包括字体大小，各种超链接等，这个时候如何实现呢？

实际上，邮件内容支持 HTML 格式，因此可以借助页面模板引擎来实现绚丽多彩的内容。

下面我们以freemarker模板引擎为例，发送一封内容为 HTML 格式的邮件。

2.4.1、引入 freemarker 依赖包

首先，在pom.xml文件中，添加freemarker依赖包。

  1. <!--freemarker 支持-->
  2. <dependency>
  3.     <groupId>org.freemarker</groupId>
  4.     <artifactId>freemarker</artifactId>
  5.     <version>2.3.23</version>
  6. </dependency>
2.4.2、编写邮件页面模板

然后，在resources/templates目录下，创建一个demo.ftl文件，示例如下！

  1. <html>
  2. <head>
  3. 	<meta charset="utf-8">
  4. 	<title></title>
  5. </head>
  6. <body>
  7. <div>您好：${userName}</div>
  8. <div>这是html文本内容</div>
  9. <img src="https://rescdn.qqmail.com/zh_CN/htmledition/images/logo/logo_0_0@2X1f1937.png" />
  10. </body>
  11. </html>
2.4.3、编写一个邮件推送服务

虽然采用 Spring Boot 提供的自动配置属性来实现邮件推送，可以极大的简化开发过程。而实际开发的时候，通常更推荐自定义一个邮件统一推送服务，这样更便于灵活的控制代码实现以及排查相关问题。

邮件统一发送服务，示范如下。

  1. @Component
  2. public class MailPushService {
  4.     private final Logger LOGGER = LoggerFactory.getLogger(MailPushService.class);
  6.     @Value("${mail.host}")
  7.     private String host;
  9.     @Value("${mail.port}")
  10.     private String port;
  12.     @Value("${mail.protocol}")
  13.     private String protocol;
  15.     @Value("${mail.username}")
  16.     private String username;
  18.     @Value("${mail.password}")
  19.     private String password;
  21.     @Value("${mail.fromEmail}")
  22.     private String fromEmail;
  24.     @Value("${mail.fromPersonal}")
  25.     private String fromPersonal;
  27.     @Autowired
  28.     private JavaMailSender mailSender;
  31.     /**
  32.      * 发送邮件（简单模式）
  33.      * @param toEmail
  34.      * @param subject
  35.      * @param content
  36.      */
  37.     public void sendMail(String toEmail, String subject,String content)  {
  38.         try {
  39.             final Properties props = new Properties();
  40.             //服务器
  41.             props.put("mail.smtp.host", host);
  42.             //端口
  43.             props.put("mail.smtp.port", port);
  44.             //协议
  45.             props.setProperty("mail.transport.protocol", protocol);
  46.             //用户名
  47.             props.put("mail.user", username);
  48.             //密码
  49.             props.put("mail.password", password);
  50.             //使用smtp身份验证
  51.             props.put("mail.smtp.auth", "true");
  53.             //开启安全协议
  54.             MailSSLSocketFactory sf = new MailSSLSocketFactory();
  55.             sf.setTrustAllHosts(true);
  56.             props.put("mail.smtp.ssl.enable", "true");
  57.             props.put("mail.smtp.ssl.socketFactory", sf);
  58.             Authenticator authenticator = new Authenticator() {
  59.                 @Override
  60.                 protected PasswordAuthentication getPasswordAuthentication() {
  61.                     return new PasswordAuthentication(props.getProperty("mail.user"),
  62.                             props.getProperty("mail.password"));
  63.                 }
  64.             };
  66.             Session session = Session.getDefaultInstance(props, authenticator);
  67.             session.setDebug(true);
  68.             MimeMessage mimeMessage = new MimeMessage(session);
  69.             mimeMessage.setFrom(new InternetAddress(fromEmail, MimeUtility.encodeText(fromPersonal)));
  70.             mimeMessage.setRecipient(MimeMessage.RecipientType.TO, new InternetAddress(toEmail));
  71.             mimeMessage.setSubject(subject);
  72.             mimeMessage.setContent(content, "text/html;charset=UTF-8");
  74.             //保存信息
  75.             mimeMessage.saveChanges();
  76.             //发送消息
  77.             Transport.send(mimeMessage);
  78.             LOGGER.info("简单邮件已经发送。");
  79.         } catch (Exception e) {
  80.             LOGGER.error("发送简单邮件时发生异常！", e);
  81.         }
  82.     }
  83. }

代码中相关自定义的全局参数配置如下：

  1. mail.host=smtp.exmail.qq.com
  2. mail.port=465
  3. mail.protocol=smtp
  4. mail.username=xxx@qq.com
  5. mail.password=xxxxxx
  6. mail.fromEmail=xxxxxx@qq.com
  7. mail.fromPersonal=发送者昵称
2.4.4、测试服务的正确性

最后，编写一个单元测试来验证服务的正确性，示例如下：

  1. @RunWith(SpringRunner.class)
  2. @SpringBootTest
  3. public class MailTest {
  5.     @Autowired
  6.     private MailPushService mailPushService;
  8.     @Test
  9.     public void testSendHtmlMail() throws Exception {
  10.         String sendHtml = buildHtmlContent("张三");
  11.         mailPushService.sendMail("xxxxx@qq.com","简单标题", sendHtml);
  12.     }
  14.     /**
  15.      * 封装html页面
  16.      * @return
  17.      * @throws Exception
  18.      */
  19.     private static String buildHtmlContent(String userName) throws Exception {
  20.         Configuration configuration = new Configuration(Configuration.VERSION_2_3_23);
  21.         configuration.setDefaultEncoding(Charset.forName("UTF-8").name());
  22.         configuration.setClassForTemplateLoading(MailTest.class, "/templates");
  23.         // 获取页面模版
  24.         Template template = configuration.getTemplate("demo.ftl");
  25.         // 动态变量替换
  26.         Map<String,Object> map = new HashMap<>();
  27.         map.put("userName", userName);
  28.         String htmlStr = FreeMarkerTemplateUtils.processTemplateIntoString(template,map);
  29.         return htmlStr;
  30.     }
  32. }

运行单元测试之后，如果没有报错，接受者会收到这样的一封邮件。

2.5、发送带附件的邮件

某些业务场景，用户希望发送的邮件中能带上附件，比如上文中，在发送 HTML 格式的邮件时，同时也带上文件附件，这个时候如何实现呢？

2.5.1、编写带附件的邮件发送

此时可以在邮件推送服务中，新增一个支持带附件的方法，实现逻辑如下。

  1. /**
  2.  * 发送邮件（复杂模式）
  3.  * @param toEmail    接受者邮箱
  4.  * @param subject    主题
  5.  * @param sendHtml   内容
  6.  * @param attachment 附件
  7.  */
  8. public void sendMail(String toEmail, String subject, String sendHtml, File attachment) {
  9.     try {
  10.         //设置了附件名过长问题
  11.         System.setProperty("mail.mime.splitlongparameters", "false");
  12.         final Properties props = new Properties();
  13.         //服务器
  14.         props.put("mail.smtp.host", host);
  15.         //端口
  16.         props.put("mail.smtp.port", port);
  17.         //协议
  18.         props.setProperty("mail.transport.protocol", protocol);
  19.         //用户名
  20.         props.put("mail.user", username);
  21.         //密码
  22.         props.put("mail.password", password);
  23.         //使用smtp身份验证
  24.         props.put("mail.smtp.auth", "true");
  26.         //开启安全协议
  27.         MailSSLSocketFactory sf = new MailSSLSocketFactory();
  28.         sf.setTrustAllHosts(true);
  29.         props.put("mail.smtp.ssl.enable", "true");
  30.         props.put("mail.smtp.ssl.socketFactory", sf);
  31.         Authenticator authenticator = new Authenticator() {
  32.             @Override
  33.             protected PasswordAuthentication getPasswordAuthentication() {
  34.                 return new PasswordAuthentication(props.getProperty("mail.user"),
  35.                         props.getProperty("mail.password"));
  36.             }
  37.         };
  39.         Session session = Session.getDefaultInstance(props, authenticator);
  40.         session.setDebug(true);
  41.         MimeMessage mimeMessage = new MimeMessage(session);
  42.         // 发送者邮箱
  43.         mimeMessage.setFrom(new InternetAddress(fromEmail, MimeUtility.encodeText(fromPersonal)));
  44.         // 接受者邮箱
  45.         mimeMessage.setRecipient(MimeMessage.RecipientType.TO, new InternetAddress(toEmail));
  46.         // 邮件主题
  47.         mimeMessage.setSubject(subject);
  48.         // 定义邮件内容
  49.         Multipart multipart = new MimeMultipart();
  51.         // 添加邮件正文
  52.         BodyPart contentPart = new MimeBodyPart();
  53.         contentPart.setContent(sendHtml, "text/html;charset=UTF-8");
  54.         multipart.addBodyPart(contentPart);
  56.         // 添加附件
  57.         if (attachment != null) {
  58.             BodyPart attachmentBodyPart = new MimeBodyPart();
  59.             // MimeUtility.encodeWord可以避免文件名乱码
  60.             FileDataSource fds=new FileDataSource(attachment);
  61.             attachmentBodyPart.setDataHandler(new DataHandler(fds));
  62.             attachmentBodyPart.setFileName(MimeUtility.encodeText(fds.getName()));
  63.             multipart.addBodyPart(attachmentBodyPart);
  64.         }
  66.         // 将multipart对象放到message中
  67.         mimeMessage.setContent(multipart);
  69.         //保存信息
  70.         mimeMessage.saveChanges();
  71.         //发送消息
  72.         Transport.send(mimeMessage);
  73.         LOGGER.info("邮件已经发送。");
  74.     } catch (Exception e) {
  75.         LOGGER.error("发送邮件时发生异常！", e);
  76.     }
  77. }
2.5.2、测试服务的正确性

最后，编写一个单元测试来验证服务的正确性，示例如下：

  1. @Test
  2. public void doSendHtmlEmail() throws Exception {
  3.     // 获取正文内容
  4.     String sendHtml = buildHtmlContent("张三");
  6.     // 获取附件
  7.     File file = new File( "~/doc/Java开发手册.pdf");
  8.     // 发送邮件
  9.     mailPushService.sendMail("xxxxx@qq.com","带附件的邮件推送", sendHtml, file);
  10. }

运行单元测试之后，如果没有报错，接受者会收到这样的一封邮件。

三、小结

最后总结一下，邮件自动推送功能在实际的业务系统中应用非常广，在发送过程中也可能会因为网络问题出现各种失败现象，因此推荐采用异步的方式来发送邮件，例如采用异步编程或者消息队列来实现，以便加快主流程的执行速度。

想要获取项目源代码的小伙伴，可以访问如下地址获取！

https://gitee.com/pzblogs/spring-boot-example-demo

四、参考

1.https://blog.csdn.net/qq_26383975/article/details/121957917

1.http://www.ityouknow.com/springboot/2017/05/06/spring-boot-mail.html

原文链接：https://www.cnblogs.com/dxflqm/p/18279869

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Spring热门文章

  • 解决springboot+activemq启动报注解错误的问题
  • Springboot整合Rabbitmq之Confirm和Return机制
  • SpringBoot SpringEL表达式的使用
  • SpringBoot自动配置原理,你真的懂吗?(简单易懂)
  • Spring源码：Bean生命周期（终章）
  • Springboot-Management的项目实践
  • 解决springboot 启动找不到主类的问题
  • Spring5路径匹配器PathPattern解析
  • SpringAOP如何获取方法参数上的注解
  • java与es8实战之五：SpringBoot应用中操作es8(带安全检查：https、账号密码、API Key)

    • Spring推荐文章

  • SpringBoot Session共享，配置不生效问题排查 → 你竟然在代码里下毒！
  • 【Spring源码分析】Spring Scope功能中的动态代理 - Scoped Proxy
  • Spring AOP概念及原理
  • SpringBoot2.7还是任性的，就是不支持Logback1.3，你能奈他何
  • SpringBoot+ Sharding Sphere 轻松实现数据库字段加解密
  • Spring MVC 中视图的实现原理，在Spring MVC 中实现重定向和转发，以及访问静态资源 - Rainbow-Sea
  • Spring MVC 中 HttpMessageConverter 转换器 - Rainbow-Sea
  • SpringBoot+mail 轻松实现各类邮件自动推送
  • Spring MVC 获取三个域(request请求域，session 会话域，application 应用域)对象的方式 - Rainbow-Sea
  • SpringBoot3整合SpringDoc实现在线接口文档

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号