本文最后更新于 2024-04-18，欢迎来到我的Blog! https://www.zpeng.site/

Springboot发送邮件mail

1、spring-boot-starter-mail

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

Spring框架提供了一个有用的实用程序库，用于发送电子邮件，使您免受底层邮件系统的限制，并负责代表客户端进行低级资源处理。

该org.springframework.mail软件包是Spring框架的电子邮件支持的根级软件包。用于发送电子邮件的中央界面是该MailSender 界面。封装了简单邮件（例如from和to，以及许多其他邮件）的属性的简单值对象是SimpleMailMessage类。此程序包还包含一个已检查异常的层次结构，该层次结构提供了比较低级别的邮件系统异常更高的抽象级别，根异常为 MailException。

2、springboot整合

application.yml

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

        <dependency>
            <groupId>com.sun.mail</groupId>
            <artifactId>javax.mail</artifactId>
            <version>1.6.2</version>
        </dependency>


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

3、代码

MailService


package com.example.mail.demo;

/**
 * 邮件服务接口，定义了多种发送邮件的方法。
 */
public interface MailService {

    /**
     * 发送简单文本邮件。
     *
     * @param to 收件人邮箱地址。
     * @param subject 邮件主题。
     * @param content 邮件正文内容。
     */
    void sendSimpleMail(String to, String subject, String content);

    /**
     * 发送HTML格式的邮件。
     *
     * @param to 收件人邮箱地址。
     * @param subject 邮件主题。
     * @param content 使用HTML格式的邮件正文内容。
     */
    void sendHtmlMail(String to, String subject, String content);

    /**
     * 发送带有附件的邮件。
     *
     * @param to 收件人邮箱地址。
     * @param subject 邮件主题。
     * @param content 邮件正文内容。
     * @param filePath 附件的文件路径。
     */
    void sendAttachmentsMail(String to, String subject, String content, String filePath);

    /**
     * 发送包含内联资源的邮件，例如图片等。
     *
     * @param to 收件人邮箱地址。
     * @param subject 邮件主题。
     * @param content 邮件正文内容，可以包含对内联资源的引用。
     * @param rscPath 资源文件的路径。
     * @param rscId 资源在邮件正文中的ID。
     */
    void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId);

}

MailServiceImpl

package com.example.mail.demo.impl;

import com.example.mail.demo.MailService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
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 javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.io.File;

/**
 * 邮件服务实现类，提供发送不同类型的邮件功能。
 */
@Component
public class MailServiceImpl implements MailService {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired
    private JavaMailSender mailSender;

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

    /**
     * 发送简单文本邮件。
     *
     * @param to      收件人邮箱地址。
     * @param subject 邮件主题。
     * @param content 邮件正文内容。
     */
    @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);
        }
    }

    /**
     * 发送HTML格式的邮件。
     *
     * @param to      收件人邮箱地址。
     * @param subject 邮件主题。
     * @param content 包含HTML内容的邮件正文。
     */
    @Override
    public void sendHtmlMail(String to, String subject, String content) {
        MimeMessage message = mailSender.createMimeMessage();

        try {
            // 创建MimeMessageHelper，支持HTML邮件和附件
            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);
        }
    }

    /**
     * 发送带有附件的邮件。
     *
     * @param to       收件人邮箱地址。
     * @param subject  邮件主题。
     * @param content  邮件正文内容。
     * @param filePath 附件的文件路径。
     */
    @Override
    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);
        }
    }

    /**
     * 发送正文内包含静态资源（如图片）的邮件。
     *
     * @param to      收件人邮箱地址。
     * @param subject 邮件主题。
     * @param content 包含静态资源引用的HTML邮件正文。
     * @param rscPath 静态资源文件路径。
     * @param rscId   资源在正文中的ID。
     */
    @Override
    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);
        }
    }
}

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="#" th:href="@{ https://www.zpeng.site/ }">激活账号</a>
</body>
</html>

application.yml

# 服务器配置
server:
  port: 8080

# Spring框架配置
spring:
  # Thymeleaf配置
  thymeleaf:
    cache: false # 关闭Thymeleaf模板的缓存
    mode: LEGACYHTML5 # 设置模式为LEGACYHTML5，放松HTML5的严格验证
    prefix: classpath:/templates/ # 指定Thymeleaf模板的前缀路径
    encoding: UTF-8 # 设置模板的编码为UTF-8
    mvc:
      static-path-pattern: /static/** # 静态资源路径配置，如JS、CSS文件等

  # 应用名称配置
  application:
    name: mail

  # 邮件服务配置
  mail:
    host: smtp.qq.com # SMTP服务器地址
    # 邮箱账号，此处为示例，请替换为实际使用的邮箱账号
    username: 33XXXXXXXXXX@qq.com
    # 邮箱授权码，用于发送邮件，此处为示例，请替换为实际的授权码
    password: abvdefghijklmn
    default-encoding: UTF-8 # 邮件默认编码设置为UTF-8
    port: 465 # SMTP端口
    protocol: smtps # 邮件协议设置为SMTPS
    properties:
      mail:
        smtp:
          ssl:
            enable: true # 启用SSL
            required: false # SSL非必需
          debug: true # 启用调试模式

4、测试

MailServiceTest

package com.example.mail;

import com.example.mail.demo.MailService;
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;

// 使用SpringRunner启动测试环境
@RunWith(SpringRunner.class)
@SpringBootTest
public class MailServiceTest {

    // 自动注入MailService服务
    @Autowired
    private MailService mailService;

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

    /**
     * 测试发送简单文本邮件
     * @throws Exception 邮件发送异常
     */
    @Test
    public void testSimpleMail() throws Exception {
        mailService.sendSimpleMail("zpeng11111@163.com", "test simple mail", " hello this is simple mail");
    }

    /**
     * 测试发送HTML格式邮件
     * @throws Exception 邮件发送异常
     */
    @Test
    public void testHtmlMail() throws Exception {
        String content = "<html>\n" +
                "<body>\n" +
                "    <h3>hello world ! 这是一封html邮件!</h3>\n" +
                "</body>\n" +
                "</html>";
        mailService.sendHtmlMail("zpeng11111@163.com", "test simple mail", content);
    }

    /**
     * 测试发送带附件的邮件
     */
    @Test
    public void sendAttachmentsMail() {
        String filePath = "D:\\home\\ruoyi\\logs\\sys-error.2024-03-26.log";
        mailService.sendAttachmentsMail("zpeng11111@163.com", "主题：带附件的邮件", "有附件，请查收！", filePath);
    }

    /**
     * 测试发送嵌入资源（如图片）的邮件
     */
    @Test
    public void sendInlineResourceMail() {
        String rscId = "zpeng006";
        String content = "<html><body>这是有图片的邮件：<img src=\'cid:" + rscId + "\' ></body></html>";
        String imgPath = "D:\\picture\\artstation\\artstation\\Aliya Chen\\aliyachen_0P2b8 1529284980aliya-chen-rocks2sm.jpg";

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

    /**
     * 测试发送模板邮件
     */
    @Test
    public void sendTemplateMail() {
        // 创建邮件正文上下文
        Context context = new Context();
        context.setVariable("id", "11111111");
        // 处理邮件模板
        String emailContent = templateEngine.process("emailTemplate", context);

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