SpringBoot3.4.3实现(文本/附件/HTML/图片)类型邮件发送案例

itbeien2025年3月3日大约 9 分钟

SpringBoot3.4.3实现(文本/附件/HTML/图片)类型邮件发送案例

本专栏前一篇文章SpringBoot3.4.2基于MyBatis和MySQL8多数据源使用示例。今天分享SpringBoot3.4.3实现(文本/附件/HTML/图片)类型邮件发送案例。邮件发送功能常在系统预警信息，用户消费后发送发票等场景经常使用，今天实现4种类型的邮件发送功能。

完整代码在文章最后，如果觉得本篇文章对你有用，记得点赞、关注、收藏哦。你的支持是我持续更新的动力!

文章最后可以加入免费的Java&AI技术和支付系统沟通社群，一起探讨Java/你的产品如何与AI结合，请按照要求加入。在群中可以聊开发、系统设计、架构、行业趋势、AI等等话题

SpringBoot3专栏软件环境

JDK17.0.12
SpringBoot3.4.3
spring-boot-starter-mail3.4.3
IDEA2024.3.3

我们先看本篇文章对应的项目结构，请看下图

1 pom依赖

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>cn.itbeien</groupId>
        <artifactId>springboot3-labs-master</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>springboot-email</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.sun.mail</groupId>
            <artifactId>javax.mail</artifactId>
            <version>RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <dependency>
            <groupId>org.junit.vintage</groupId>
            <artifactId>junit-vintage-engine</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.hamcrest</groupId>
                    <artifactId>hamcrest-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

</project>

2 项目配置信息

spring.mail.host=smtp.163.com
spring.mail.username=xxx@163.com
spring.mail.password=xxx

spring.mail.default-encoding=UTF-8

from.mail.address=xxx@163.com

3 邮件发送核心代码

package cn.itbeien.mail.service.impl;

import cn.itbeien.mail.service.MailService;
import jakarta.annotation.Resource;
import jakarta.mail.MessagingException;
import jakarta.mail.internet.MimeMessage;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Component;

import java.io.File;

/**
 * @author itbeien
 * 项目网站：https://www.itbeien.cn
 * 公众号：贝恩聊架构
 * 全网同名，欢迎小伙伴们关注
 * Java/AI学习社群
 * Copyright© 2025 itbeien
 */
@Component
@Slf4j
public class MailServiceImpl implements MailService {

    @Resource
    private JavaMailSender mailSender;

    @Value("${from.mail.address}")
    private String from;

    /**
     * 发送文本邮件
     * @param to
     * @param subject
     * @param content
     */
    @Override
    public void sendSimpleMail(String to, String subject, String content) {
        // 创建一个SimpleMailMessage对象
        SimpleMailMessage message = new SimpleMailMessage();
        // 设置发件人
        message.setFrom(from);
        // 设置收件人
        message.setTo(to);
        // 设置邮件主题
        message.setSubject(subject);
        // 设置邮件内容
        message.setText(content);

        try {
            // 发送邮件
            mailSender.send(message);
            // 记录日志
            log.info("文本邮件已经发送");
        } catch (Exception e) {
            // 记录异常日志
            log.error("happen sendSimpleMail error！", e);
        }

    }

    /**
     * 发送html邮件
     * @param to
     * @param subject
     * @param content
     */
    @Override
    public void sendHtmlMail(String to, String subject, String content) {
        //创建一个MimeMessage对象
        MimeMessage message = mailSender.createMimeMessage();

        try {
            //true表示需要创建一个multipart message
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            //设置发件人
            helper.setFrom(from);
            //设置收件人
            helper.setTo(to);
            //设置邮件主题
            helper.setSubject(subject);
            //设置邮件内容，true表示需要创建一个multipart message
            helper.setText(content, true);

            //发送邮件
            mailSender.send(message);
            //记录日志
            log.info("html邮件发送成功");
        } catch (MessagingException e) {
            //记录异常日志
            log.error("happen sendHtmlMail error！", e);
        }
    }


    /**
     * 发送带附件的邮件
     * @param to
     * @param subject
     * @param content
     * @param filePath
     */
    @Override
    public void sendAttachmentsMail(String to, String subject, String content, String filePath){
        // 创建MimeMessage对象
        MimeMessage message = mailSender.createMimeMessage();

        try {
            // 创建MimeMessageHelper对象，用于设置邮件内容
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            // 设置发件人
            helper.setFrom(from);
            // 设置收件人
            helper.setTo(to);
            // 设置邮件主题
            helper.setSubject(subject);
            // 设置邮件内容，true表示支持html格式
            helper.setText(content, true);

            // 创建FileSystemResource对象，用于添加附件
            FileSystemResource file = new FileSystemResource(new File(filePath));
            // 获取文件名
            String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
            // 添加附件
            helper.addAttachment(fileName, file);
            //helper.addAttachment("test"+fileName, file);

            // 发送邮件
            mailSender.send(message);
            // 记录日志
            log.info("带附件的邮件已经发送");
        } catch (MessagingException e) {
            // 记录异常日志
            log.error("happen sendAttachmentsMail error！", e);
        }
    }


    /**
     * 发送正文中有静态资源（图片）的邮件
     * @param to
     * @param subject
     * @param content
     * @param rscPath
     * @param rscId
     */
    @Override
    public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId){
        // 创建MimeMessage对象
        MimeMessage message = mailSender.createMimeMessage();

        try {
            // 创建MimeMessageHelper对象，用于设置邮件内容
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            // 设置发件人
            helper.setFrom(from);
            // 设置收件人
            helper.setTo(to);
            // 设置邮件主题
            helper.setSubject(subject);
            // 设置邮件正文，true表示正文是HTML格式
            helper.setText(content, true);

            // 创建FileSystemResource对象，用于读取静态资源文件
            FileSystemResource res = new FileSystemResource(new File(rscPath));
            // 将静态资源文件嵌入到邮件正文中
            helper.addInline(rscId, res);

            // 发送邮件
            mailSender.send(message);
            // 记录日志
            log.info("嵌入静态图片的邮件已经发送");
        } catch (MessagingException e) {
            // 记录异常日志
            log.error("happen sendInlineResourceMail error！", e);
        }
    }
}

4 单元测试代码

package cn.itbeien.mail;

import cn.itbeien.mail.service.MailService;
import jakarta.annotation.Resource;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;

/**
 * @author itbeien
 * 项目网站：https://www.itbeien.cn
 * 公众号：贝恩聊架构
 * 全网同名，欢迎小伙伴们关注
 * Java/AI学习社群
 * Copyright© 2025 itbeien
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class MailBootTest {
    // 注入邮件服务
    @Resource
    private MailService mailServiceImpl;

    // 注入模板引擎
    @Autowired
    private TemplateEngine templateEngine;

    // 测试发送简单文本邮件
    @Test
    public void testSimpleMail() throws Exception {
        mailServiceImpl.sendSimpleMail("xxx@163.com","测试简单的文本邮件","这时一封简单的文本邮件");
    }

    // 测试发送html邮件
    @Test
    public void testHtmlMail() throws Exception {
        String content="<html>\n" +
                "<body>\n" +
                "    <h2>hello itbeien ! 这是一封html邮件!</h2>\n" +
                "</body>\n" +
                "</html>";
        mailServiceImpl.sendHtmlMail("xxx@163.com","这是html邮件",content);
    }

    // 测试发送带附件的邮件
    @Test
    public void sendAttachmentsMail() {
        String filePath="C:\\Users\\Administrator\\Downloads\\spring-copy.png";
        mailServiceImpl.sendAttachmentsMail("xxx@163.com", "主题：带附件的邮件", "有附件，请查收！", filePath);
    }


    // 测试发送带图片的邮件
    @Test
    public void sendInlineResourceMail() {
        String rscId = "itbeien";
        String content="<html><body>这是有图片的邮件：<img src=\'cid:" + rscId + "\' ></body></html>";
        String imgPath = "C:\\Users\\Administrator\\Downloads\\spring-copy.png";

        mailServiceImpl.sendInlineResourceMail("xxx@163.com", "主题：这是有图片的邮件", content, imgPath, rscId);
    }


    // 测试发送模板邮件
    @Test
    public void sendTemplateMail() {
        //创建邮件正文
        Context context = new Context();
        context.setVariable("content", "tech/SpringBoot3/17SpringBoot3.4.2基于Mybatis和MySQL8多数据源使用示例.html");
        String emailContent = templateEngine.process("emailTemplate", context);

        mailServiceImpl.sendHtmlMail("xxx@163.com","主题：这是模板邮件",emailContent);
    }
}