Spring Boot的邮件发送

最新推荐文章于 2023-04-14 10:19:36 发布

小小Java开发者

最新推荐文章于 2023-04-14 10:19:36 发布

阅读量455

点赞数

分类专栏： Spring Boot

本文链接：https://blog.csdn.net/weixin_43759352/article/details/109298559

版权

Spring Boot 专栏收录该内容

37 篇文章 20 订阅

订阅专栏

Spring Boot的邮件发送

邮件发送是一个常见的功能，注册时的身份认证、重要通知发送等都会用到邮件发送。下面就来详细介绍Spring Boot中如何进行发送邮件的；以及介绍几种不同的邮件的发送方式：分别是发送简单邮件、发送带有附件的邮件、发送带有图片的邮件、以及使用两种模板引擎来构建邮件模板等。

前言

下面将进行介绍，几种不同的邮件的发送方式。

一、发送前的准备

1.登录QQ邮箱

登录QQ邮箱后，找到顶部的设置按钮——>账户按钮。如下图所示：
在这里插入图片描述

2.开启服务，获取授权码

在账户选项中，找到POP3/SMTP服务，点击开启，如下图所示：
在这里插入图片描述
注：这里我已经开启过了，若之前没有开启，点击开启按钮后，按照步骤，将会获取一个授权码，该授权码在后面将会用到的哦。

二、邮件发送

1.环境搭建

创建一个springboot项目，具体创建过程这里不再介绍；项目创建完成后，添加以下依赖：

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

完成后，在配置文件application.properties中配置邮件的基本信息，如下所示

#用户账号
spring.mail.username=1154146166@qq.com

#密码
spring.mail.password=上面获取的授权码

#服务器地址
spring.mail.host=smtp.qq.com

#配置端口
spring.mail.port=465

#配置默认编码
spring.mail.default-encoding=UTF-8

#开启debug，方便开发者查看邮件发送的日志
spring.mail.properties.mail.debug=true

spring.mail.properties.mail.smtp.ssl.enable=true

完成这些配置后，基本的邮件发送环境就搭建成功了。

2.发送简单邮件

package com.example;

import org.junit.jupiter.api.Test;
import org.springframework.beans.Mergeable;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.JavaMailSenderImpl;

@SpringBootTest
class SpringbootMailApplicationTests {

    @Autowired
    JavaMailSender javaMailSender;

    @Test
    void contextLoads() {

    }

    @Test
    void  sendSimpleMailTest() {

        SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
        simpleMailMessage.setSubject("通知——今天不上班");   //邮件的主题
        simpleMailMessage.setText("大家休息一天！！！");   //邮件的内容
        simpleMailMessage.setTo("1154146166@qq.com");   //邮件的收件人
        simpleMailMessage.setFrom("1154146166@qq.com");  //邮件的发送者
        simpleMailMessage.setCc("1154146166@qq.com");    //邮件的抄送人
        javaMailSender.send(simpleMailMessage);

    }

}

执行该方法，即可看到邮件发送成功。如下图所示：
在这里插入图片描述

3.发送带有附件的邮件

 @Test
    void SendAttachFileMailTest() throws Exception{

        File file = new File("E:\\mail\\mailTest.txt");
        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
        
        helper.setSubject("通知——今天不上班");     //邮件的主题
        helper.setText("<b style='color:red'>大家休息一天！！！</b>",true);    //邮件的内容
        helper.setTo("1154146166@qq.com");    //邮件的收件人
        helper.setFrom("1154146166@qq.com");    //邮件的发送者
       
        helper.addAttachment(file.getName(),file);  // 上传文件
        
        javaMailSender.send(mimeMessage);


    }

注：使用MimeMessageHelper简化了邮件的配置，他的构造方法的第二个参数为true，表示构造一个multipart message类型的邮件，multipart message类型的邮件包含多个正文，附件，以及内嵌资源，邮件的表现形式更加的丰富。最后是通过addAttachment方法添加附件。
执行该方法，即可看到邮件发送成功。如下图所示：
在这里插入图片描述

4.发送带有图片资源的邮件

/**
     * （3）发送带有图片资源的文件
     */
    @Test
    void SendMailWithImg() throws Exception {
        File file = new File("E:\\mail\\mailTest.png");
        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
        helper.setFrom("1154146166@qq.com");  // //邮件的发送者
        helper.setTo("1154146166@qq.com");    //邮件的收件人
        helper.setSubject("通知——今天不上班");     //邮件的主题
        helper.setText("<div>大家休息一天！！！"+"<div><img src='cid:p01'/></div>"+"</div>",true);    //邮件的内容
        FileSystemResource resource = new FileSystemResource(file);
        helper.addInline("p01", resource);    //将资源加入邮件对象中
        javaMailSender.send(mimeMessage);
    }

注意：在调用MimeMessageHelper中的setText方法的时候，第二个参数true表示：邮件正文是HTML格式的，不传该参数，则默认为false。

执行该方法，即可看到邮件发送成功。如下图所示：
在这里插入图片描述

5.使用FreeMarker构建邮件模板

对于格式较为复杂的邮件，若采用字符串进行HTML拼接的方式，不但容易出错，而且不易于维护；下面使用HTML模板可以很好的解决这个问题。当然，使用FreeMarker构建邮件模板，首先要添加FreeMarker的依赖：

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

在resources目录templates目录下面创建mailtemplate.ftl文件作为邮件模板，这里演示的模板比较简单，显示了邮件的内容（可以根据实际的需要定制较为复杂的模板）：


<div>
    <p>邮件内容：</p>
    <b> ${msg}</b>
</div>

然后创建了一个实体类，为了演示方便，只定义了msg属性。

package com.example.pojo;

public class Message {
    private String msg;
    public Message() {

    }
    public Message(String msg) {
        this.msg = msg;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

 @Autowired
    private FreeMarkerConfigurer configurer;
 @Test
    void  SendHtmlMailTest() throws Exception{

        Template template = configurer.getConfiguration().getTemplate("mailtemplate.ftl");
        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
        StringWriter mail = new StringWriter();
        Message message = new Message();
        message.setMsg("今天休息。。。");
        template.process(message, mail);
        helper.setFrom("1154146166@qq.com");  // //邮件的发送者
        helper.setTo("1154146166@qq.com");    //邮件的收件人
        helper.setSubject("通知——今天不上班");     //邮件的主题
        helper.setText(mail.toString(),true);    //邮件的内容
        javaMailSender.send(mimeMessage);
    }

执行该方法，即可看到邮件发送成功。如下图所示：
在这里插入图片描述

6.使用Thymeleaf构建邮件模板

既然可以使用FreeMarker来进行构建邮件的模板，当然也可以使用hymeleaf来进行构建邮件的模板！！！
首先添加依赖：

  <!--引入thymeleaf依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

然后在resources目录templates目录下面创建mailtemplate.html文件作为邮件模板；这里演示的模板比较简单，显示了邮件的内容（可以根据实际的需要定制较为复杂的模板）：

<!doctype html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>演示邮件</title>
</head>
<body>
<p th:text="${msg}"></p>
</body>
</html>

 /**
     * (5)使用Thymeleaf构建邮件模板
     */
     
    @Autowired
    TemplateEngine templateEngine;
    
    @Test
    void SendHtmlMailTest2() throws Exception {

        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);

        Context context = new Context();

        context.setVariable("msg","今天大家休息，不上班。。。");
        String mail = templateEngine.process("mailtemplate.html", context);

        helper.setFrom("1154146166@qq.com");  // //邮件的发送者
        helper.setTo("1154146166@qq.com");    //邮件的收件人
        helper.setSubject("通知——今天不上班");     //邮件的主题
        helper.setText(mail,true);    //邮件的内容
        javaMailSender.send(mimeMessage);

    }

注：不同于FreeMarker,Thymeleaf使用了TemplateEngine来对模板进行渲染。通过Context进行构造模板中变量需要的值，使用这种方式比FreeMarker构建邮件模板更加的方便。
执行该方法，即可看到邮件发送成功。如下图所示：
在这里插入图片描述

总结

以上分别介绍了几种不同的邮件的发送方式，以及如何来进行构建邮件模板等。希望通过以上例子能给予大家帮助。😊

关于本项目代码获取方式：关注+私信并回复：【邮件发送】即可获取哦！！！
在这里插入图片描述

小小Java开发者

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
打赏
1
评论
Spring Boot的邮件发送

【第一部分】历史文章：SpringBoot总结（一）——第一个SpringBoot项目SpringBoot总结（二）——Spring Boot的自动配置SpringBoot总结（三）——SpringBoot的配置文件SpringBoot总结（四）——@Value和@ConfigurationProperties的区别SpringBoot总结（五）——@PropertySource注解与@ImportResource注解SpringBoot总结（六）——SpringBoot配置文件占位符Spri
复制链接

扫一扫