SpringBoot整合Mail轻松实现邮件自动推送功能

更新时间：2024年12月15日 10:30:09 作者：技术栈人员

在项目中经常会遇到SpringBoot推送消息的业务,除了站内推送通知,邮件推送也是一种常见的方式,本文小编就给大家介绍了SpringBoot整合Mail轻松实现邮件自动推送功能,需要的朋友可以参考下

简单使用

1、pom 包配置

pom 包里面添加 spring-boot-starter-mail 包引用

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

2、在 application.properties 中添加邮箱配置

spring.mail.host=smtp.qiye.163.com //邮箱服务器地址
spring.mail.username=xxx@oo.com //用户名
spring.mail.password=xxyyooo    //密码
spring.mail.default-encoding=UTF-8
 
mail.fromMail.addr=xxx@oo.com  //以谁来发送邮件

3、编写 mailService，这里只提出实现类。

@Component
public class MailServiceImpl implements MailService{
 
    private final Logger logger = LoggerFactory.getLogger(this.getClass());
 
 
    @Autowired
    private JavaMailSender mailSender;
 
    @Value("${mail.fromMail.addr}")
    private String from;
 
    @Override
    public void sendSimpleMail(String to, String subject, String content) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setFrom(from);
        message.setTo(to);
        message.setSubject(subject);
        message.setText(content);
 
        try {
            mailSender.send(message);
            logger.info("简单邮件已经发送。");
        } catch (Exception e) {
            logger.error("发送简单邮件时发生异常！", e);
        }
    }
}

4、编写 test 类进行测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class MailServiceTest {
 
    @Autowired
    private MailService MailService;
 
    @Test
    public void testSimpleMail() throws Exception {
        MailService.sendSimpleMail("test@126.com","test simple mail"," hello this is simple mail");
    }
}

至此一个简单的文本发送就完成了。

高级玩法

但是在正常使用的过程中，我们通常在邮件中加入图片或者附件来丰富邮件的内容，下面讲介绍如何使用 Spring Boot 来发送丰富的邮件。

发送 html 格式邮件

其它都不变在 MailService 添加 sendHtmlMail 方法.

public void sendHtmlMail(String to, String subject, String content) {
    MimeMessage message = mailSender.createMimeMessage();
 
    try {
        //true表示需要创建一个multipart message
        MimeMessageHelper helper = new MimeMessageHelper(message, true);
        helper.setFrom(from);
        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(content, true);
 
        mailSender.send(message);
        logger.info("html邮件发送成功");
    } catch (MessagingException e) {
        logger.error("发送html邮件时发生异常！", e);
    }
}

在测试类中构建 html 内容，测试发送

@Test
public void testHtmlMail() throws Exception {
    String content="<html>\n" +
            "<body>\n" +
            "    <h3>hello world ! 这是一封Html邮件!</h3>\n" +
            "</body>\n" +
            "</html>";
    MailService.sendHtmlMail("test@126.com","test simple mail",content);
}

发送带附件的邮件

在 MailService 添加 sendAttachmentsMail 方法.

public void sendAttachmentsMail(String to, String subject, String content, String filePath){
    MimeMessage message = mailSender.createMimeMessage();
 
    try {
        MimeMessageHelper helper = new MimeMessageHelper(message, true);
        helper.setFrom(from);
        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(content, true);
 
        FileSystemResource file = new FileSystemResource(new File(filePath));
        String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
        helper.addAttachment(fileName, file);
 
        mailSender.send(message);
        logger.info("带附件的邮件已经发送。");
    } catch (MessagingException e) {
        logger.error("发送带附件的邮件时发生异常！", e);
    }
}

添加多个附件可以使用多条 helper.addAttachment(fileName,file)

在测试类中添加测试方法

@Test
public void sendAttachmentsMail() {
    String filePath="e:\\tmp\\application.log";
    mailService.sendAttachmentsMail("test@126.com", "主题：带附件的邮件", "有附件，请查收！", filePath);
}

发送带静态资源的邮件

邮件中的静态资源一般就是指图片，在 MailService 添加 sendAttachmentsMail 方法.

public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId){
    MimeMessage message = mailSender.createMimeMessage();
 
    try {
        MimeMessageHelper helper = new MimeMessageHelper(message, true);
        helper.setFrom(from);
        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(content, true);
 
        FileSystemResource res = new FileSystemResource(new File(rscPath));
        helper.addInline(rscId, res);
 
        mailSender.send(message);
        logger.info("嵌入静态资源的邮件已经发送。");
    } catch (MessagingException e) {
        logger.error("发送嵌入静态资源的邮件时发生异常！", e);
    }
}

在测试类中添加测试方法

@Test
public void sendInlineResourceMail() {
    String rscId = "neo006";
    String content="<html><body>这是有图片的邮件：<img src=\'cid:" + rscId + "\' ></body></html>";
    String imgPath = "C:\\Users\\summer\\Pictures\\favicon.png";
 
    mailService.sendInlineResourceMail("test@126.com", "主题：这是有图片的邮件", content, imgPath, rscId);
}

添加多个图片可以使用多条 <imgsrc='cid:" + rscId + "'> 和 helper.addInline(rscId,res) 来实现

到此所有的邮件发送服务已经完成了。

邮件系统

上面发送邮件的基础服务就这些了，但是如果我们要做成一个邮件系统的话还需要考虑以下几个问题：

邮件模板

我们会经常收到这样的邮件：

尊敬的xxx用户：

恭喜您注册成为xxx网的用户,，同时感谢您对xxx的关注与支持并欢迎您使用xx的产品与服务。
...

其中只有 xxx 这个用户名在变化，其它邮件内容均不变，如果每次发送邮件都需要手动拼接的话会不够优雅，并且每次模板的修改都需要改动代码的话也很不方便，因此对于这类邮件需求，都建议做成邮件模板来处理。模板的本质很简单，就是在模板中替换变化的参数，转换为 html 字符串即可，这里以 thymeleaf为例来演示。

1、pom 中导入 thymeleaf 的包

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

2、在 resorces/templates 下创建 emailTemplate.html

<!DOCTYPE html>
<html lang="zh" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8"/>
        <title>Title</title>
    </head>
    <body>
        您好,这是验证邮件,请点击下面的链接完成验证,<br/>
        <a href="#" rel="external nofollow"  th:href="@{ http://www.test.com/{id}(id=${id}) }" rel="external nofollow" >激活账号</a>
    </body>
 
</html>

3、解析模板并发送

@Test
public void sendTemplateMail() {
    //创建邮件正文
    Context context = new Context();
    context.setVariable("id", "006");
    String emailContent = templateEngine.process("emailTemplate", context);
 
    mailService.sendHtmlMail("test@126.com","主题：这是模板邮件",emailContent);
}

发送失败

因为各种原因，总会有邮件发送失败的情况，比如：邮件发送过于频繁、网络异常等。在出现这种情况的时候，我们一般会考虑重新重试发送邮件，会分为以下几个步骤来实现：

1、接收到发送邮件请求，首先记录请求并且入库。
2、用邮件发送接口发送邮件，并且将发送结果记录入库。
3、启动定时系统扫描时间段内，未发送成功并且重试次数小于3次的邮件，进行再次发送

异步发送

很多时候邮件发送并不是我们主业务必须关注的结果，比如通知类、提醒类的业务可以允许延时或者失败。这个时候可以采用异步的方式来发送邮件，加快主交易执行速度，在实际项目中可以采用MQ发送邮件相关参数，监听到消息队列之后启动发送邮件。

以上就是SpringBoot整合Mail轻松实现邮件自动推送功能的详细内容，更多关于SpringBoot Mail邮件推送的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Java控制结构知识点详解
在本篇文章里小编给大家分享的是关于Java控制结构知识点详解，有需要的朋友们可以参考下。
2019-10-10
java 线程中start方法与run方法的区别详细介绍
这篇文章主要介绍了java 线程中start方法与run方法的区别详细介绍的相关资料,在java线程中调用start方法与run方法的区别在哪里？这两个问题是两个非常流行的初学者级别的多线程面试问题，这里进行详细说明，需要的朋友可以参考下
2016-11-11
使用Java实现简单串口通信
这篇文章主要介绍了使用Java实现简单串口通信，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-07-07
Eclipse IDE中如何设置JVM启动参数
这篇文章主要介绍了Eclipse IDE中如何设置JVM启动参数，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-06-06
java拼接字符串时去掉最后一个多余逗号的方法
这篇文章主要介绍了java拼接字符串时去掉最后一个多余逗号的方法,实例分析了java操作字符串的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-03-03
JAVA获取rabbitmq消息总数过程详解
这篇文章主要介绍了JAVA获取rabbitmq消息总数过程详解，公司使用的是rabbitMQ，需要做监控预警的job去监控rabbitMQ里面的堆积消息个数，如何使用rabbitMQ获取监控的队列里面的队列消息个数呢,需要的朋友可以参考下
2019-07-07
一篇文章带你了解Spring AOP 的注解
这篇文章主要为大家介绍了vue组件通信的几种方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
2022-01-01
微服务通过Feign调用进行密码安全认证操作
这篇文章主要介绍了微服务通过Feign调用进行密码安全认证操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
基于Properties文件中的空格问题
这篇文章主要介绍了Properties文件中的空格问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
Java的Socket实现长连接以及数据的发送和接收方式
这篇文章主要介绍了Java的Socket实现长连接以及数据的发送和接收方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-09-09