Spring Boot使用Spring Mail发送邮件

更新时间：2025年05月24日 11:24:45 作者：wx661607c93692e

在现代应用程序中,邮件通知是一种非常常见的需求,无论是用户注册成功后的欢迎邮件,还是系统异常时的报警邮件,都离不开邮件服务的支持,Spring Boot提供了简便的方式Spring Mail来集成邮件发送功能,使得开发者能够快速地为应用添加邮件发送能力

一、简介

在现代应用程序中，邮件通知是一种非常常见的需求，无论是用户注册成功后的欢迎邮件，还是系统异常时的报警邮件，都离不开邮件服务的支持。Spring Boot 提供了简便的方式来集成邮件发送功能，使得开发者能够快速地为应用添加邮件发送能力

二、Spring Mail 概述

2.1 什么是 Spring Mail？

Spring Mail 是 Spring Framework 提供的一个模块，它简化了 JavaMail API 的使用，提供了更高层次的抽象，让开发者更容易地发送邮件。Spring Boot 对 Spring Mail 进行了进一步的封装，使其更加易于配置和使用。

2.2 主要功能

简单邮件：发送纯文本或HTML格式的邮件。
附件邮件：发送带有附件的邮件。
模板邮件：使用模板引擎（如 Thymeleaf）生成动态内容的邮件。

三、基本配置与使用

3.1 添加依赖

首先，在 pom.xml 文件中添加 Spring Mail 和 JavaMail Sender 的依赖项：

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

3.2 配置邮件服务器

接下来，需要在 application.properties 或 application.yml 文件中配置邮件服务器的相关信息：

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=your-email@gmail.com
spring.mail.password=your-password
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

注意：上述配置适用于 Gmail SMTP 服务器。如果你使用的是其他邮件服务商，请根据实际情况调整配置。

四、发送邮件

4.1 发送简单文本邮件

使用 JavaMailSender 接口可以方便地发送邮件。以下是一个发送简单文本邮件的例子：

@Service
public class EmailService {

    @Autowired
    private JavaMailSender mailSender;

    public void sendSimpleMessage(String to, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setTo(to);
        message.setSubject(subject);
        message.setText(text);
        mailSender.send(message);
    }
}

4.2 发送富文本邮件

如果需要发送包含 HTML 内容的邮件，可以使用 MimeMessage 来创建更复杂的邮件消息：

@Service
public class EmailService {

    @Autowired
    private JavaMailSender mailSender;

    public void sendHtmlMessage(String to, String subject, String htmlBody) throws MessagingException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message, true);

        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(htmlBody, true); // 设置为true表示邮件体是html格式

        mailSender.send(message);
    }
}

4.3 发送带附件的邮件

有时我们需要发送带有附件的邮件，比如发票、报告等文件。可以通过设置 MimeMessageHelper 的 addAttachment() 方法来实现：

@Service
public class EmailService {

    @Autowired
    private JavaMailSender mailSender;

    public void sendMessageWithAttachment(
            String to, String subject, String text, String pathToAttachment) throws MessagingException {
        MimeMessage message = mailSender.createMimeMessage();

        MimeMessageHelper helper = new MimeMessageHelper(message, true);

        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(text);

        FileSystemResource file = new FileSystemResource(new File(pathToAttachment));
        helper.addAttachment(file.getFilename(), file);

        mailSender.send(message);
    }
}

五、高级特性

5.1 使用模板引擎

对于需要动态生成内容的邮件，可以使用模板引擎（如 Thymeleaf）。首先，添加 Thymeleaf 依赖：

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

然后定义一个控制器来渲染模板并发送邮件：

@Service
public class EmailService {

    @Autowired
    private JavaMailSender mailSender;

    @Autowired
    private SpringTemplateEngine templateEngine;

    public void sendTemplateMessage(String to, String subject, Map<String, Object> templateModel) throws MessagingException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message, true);

        helper.setTo(to);
        helper.setSubject(subject);

        Context context = new Context();
        context.setVariables(templateModel);

        String htmlContent = templateEngine.process("email-template", context);
        helper.setText(htmlContent, true);

        mailSender.send(message);
    }
}

其中 email-template.html 是位于 resources/templates/ 目录下的 Thymeleaf 模板文件。

5.2 异步发送邮件

为了提高性能，特别是当发送大量邮件时，可以考虑异步发送邮件。只需在方法上添加 @Async 注解，并确保已在主类中启用了异步支持（参见前文关于异步处理的部分）：

@Service
public class AsyncEmailService {

    @Autowired
    private JavaMailSender mailSender;

    @Async
    public void sendEmailAsync(String to, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setTo(to);
        message.setSubject(subject);
        message.setText(text);
        mailSender.send(message);
    }
}

六、总结

到此这篇关于Spring Boot使用Spring Mail发送邮件的文章就介绍到这了,更多相关Spring Boot中的邮件发送内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

基于slf4j日志MDC输出格式的问题
这篇文章主要介绍了基于slf4j日志MDC输出格式的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
在IDEA中实现同时运行2个相同的java程序
这篇文章主要介绍了在IDEA中实现同时运行2个相同的java程序，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-02-02
Java使用ffmpeg和mencoder实现视频转码
这篇文章主要为大家详细介绍了Java使用ffmpeg和mencoder实现视频转码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-12-12
Spring两种任务调度Scheduled和Async的区别和应用场景详解
在现代应用程序中,任务调度是一个非常普遍的需求,Spring框架提供了两种主要的方式来实现任务调度：Scheduled 和 Async,在这篇文章中,我们将详细介绍这两种方式的区别和应用场景,需要的朋友可以参考下
2024-12-12
java操作json对象出现StackOverflow错误的问题及解决
这篇文章主要介绍了java操作json对象出现StackOverflow错误的问题及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-06-06
java与C 代码运行效率的对比（整理）
最近和朋友无意间讨论起了有关java 和C 的效率问题，（我是java 推介者，他是 c 语言推介者，他做的是嵌入式）故，想通过网络查询一下，总结一下，两者到底效率如何，其有何差异，原因又是啥？各种优势有在何处？
2021-04-04
浅谈JSONObject的使用及示例代码(JSON解析)
这篇文章主要介绍了浅谈JSONObject的使用及示例代码(JSON解析),本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-01-01
Java基本数据类型族谱与易错点梳理解析
Java有八大基本类型，很多同学只对经常使用的int类型比较了解。有的同学是刚从C语言转入Java学习，误以为两者的基本数据类型完全相同，这也是大错特错的。今天这本Java基本数据类型全解析大字典，可以帮助你直接通过目录找到你想要了解某一种基本数据类型
2022-01-01
idea maven pom不自动更新的解决方法
这篇文章主要介绍了idea maven pom不自动更新的解决方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-08-08
利用过滤器修改response中的返回值
文章介绍了如何通过继承HttpServletResponseWrapper并重写Response对象的方法来获取response中的返回值,同时还分享了如何配置过滤器
2024-12-12