SpringBoot整合邮件发送

于 2024-07-17 12:24:41 发布
阅读量369 收藏 4
点赞数 5
分类专栏： Java开发 文章标签： spring boot java 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhuge_long/article/details/140491550
版权

利用JavaMail完成发送激活邮件的功能。当前案例是以腾讯qq邮箱服务器为演示案例：

开启邮件服务授权

qq邮箱服务器官方会回送一个授权码在网页，类似下图的效果：

邮件发送流程

因为springboot提供了java操作邮件发送的启动器，所以在springboot 项目中完成邮件发送的功能，还是很简单、方便的。大致流程如下所示：

pom.xml 引入邮件发送启动器

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

通过JavaMail的API完成邮件发送功能的代码封装，此处直接提供的工具类

  • 抽取接口
public interface MailService {
    void sendSimpleMail(String to, String subject, String content);
    void sendHtmlMail(String to, String subject, String content);
    void sendAttachmentsMail(String to, String subject,String content, String filePath);
    void sendInlineResourceMail(
            String to, String subject,
            String content, String rscPath, String rscId);
}
  • 实现类
@Slf4j
@Component
@Data
@ConfigurationProperties(prefix = "spring.mail")
public class MailUtil implements MailService{
    @Autowired
    private JavaMailSender mailSender; //springboot提供的邮件发送的api
    private String from;//获取发件人的邮箱地址

    @Override
    public void sendSimpleMail(String to, String subject, String content) {
        log.info("from===="+from);
        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) {
            e.printStackTrace();
            log.error("发送简单邮件时发生生异常!", e);
        }
    }
    @Override
    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); //邮件内容包含html
            mailSender.send(message);
            log.info("html邮件发送成功");
        } catch (Exception e) {
            log.error("发送html邮件时发生生异常!", e);
        }
    }
    @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 = file.getFilename();
            helper.addAttachment(fileName, file); //设置附件

            // helper.addAttachment("test"+fileName, file);
            mailSender.send(message);
            log.info("带附件的邮件已经发送。");
        } catch (Exception e) {
            log.error("发送带附件的邮件时发生生异常!", e);
        }
    }
    @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);
            log.info("嵌入静态资源的邮件已经发送。");
        } catch (Exception e) {
            log.error("发送嵌入静态资源的邮件时发生异常!", e);
        }
    }
}
  • from，即为邮件发送者，一般设置在配置文件中
  • to，邮件接收者，此参数可以为数组，同时发送多人
  • subject，邮件主题
  • content，邮件的主体
  • 邮件发送者 from 一般采用固定的形式写到配置文件中。

application.yaml中配置邮件服务器信息

spring:        
    mail:
        protocol: smtp
        host: smtp.qq.com #邮箱服务器主机，可以配置不用的邮件服务商  126  163  qq
        username: xxxxxxxxxx@qq.com #  开通邮件授权功能的邮箱用户名
        password: xxxxxxxx #授权码
        port: 25 # 端口
        from: xxxxxxx@qq.com #实际发送邮件的邮箱地址发件人
        default-encoding: utf-8  #编码格式，设置邮件正文的编码格式，因为邮件可以发送富文本[即html代码，需要浏览器解析，解析使用什么编码通过该属性指定]
        properties: # 设置超时时间
            mail:
                smtp:
                    connectiontimeout: 5000
                    timeout: 3000
                    writetimeout: 5000
                    ssl: # 配置SSL 加密
                        # 本地测试
                        enable: false
                        required: false
                # 开启debug模式，这样邮件发送过程的日志会在控制台打印出来，方便排查
                debug: true

扩展：其他邮箱服务器的配置方式：

在 application.properties 中添加邮箱配置，不同的邮箱参数稍有不同，下面面列举几个常用邮箱配置。

163 邮箱配置

spring.mail.host=smtp.163.com   // 邮箱服务器器地址
spring.mail.username=xxx@163.com // 用用户名
spring.mail.password=xxx        // 密码
spring.mail.default-encoding=UTF-8

// 超时时间，可选
spring.mail.properties.mail.smtp.connectiontimeout=5000
spring.mail.properties.mail.smtp.timeout=3000
spring.mail.properties.mail.smtp.writetimeout=5000

126 邮箱配置

spring.mail.host=smtp.126.com 
spring.mail.username=xxx@126.com
spring.mail.password=xxx
spring.mail.default-encoding=UTF-8

QQ 邮箱配置如下:

spring.mail.host=smtp.qq.com
spring.mail.username=xxx@qq.com
spring.mail.password=xxx
spring.mail.default-encoding=UTF-8

测试时需要将 spring.mail.username 和 spring.mail.password 改成自自己邮箱对应的登录名和密码，这里的密码不是邮箱的登录密码，是开启 POP3 之后设置的客户端授权密码。

测试工具类方法：

在日常使用的过程中,我们通常在邮件中加入图片或者附件来丰富邮件的内容。

发送 HTML 格式邮件

邮件发送支持以 HTML 语法去构建自定义的邮件格式,Spring Boot 支持使用用 HTML 发送邮件。

我们在 MailService 中添加支持 HTML 邮件发送的方法:

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);
    }
}

富文本邮件抄送使用:helper.addCc(cc) 来实现。

和文本邮件发送代码对比,富文本邮件发送使用 MimeMessageHelper 类,该类支持发送复杂邮件模板,支持文本、附件、HTML、图片等。

在测试类中构建 HTML 内容,测试发送:

@Test
public void testHtmlMail() throws Exception {
    String content = 
    "<html>\n" + 
        "<body>\n" + 
            "<h3>hello world ! 这是一一封html邮件!</h3>\n" +
        "</body>\n" +
    "</html>";

    mailService.sendHtmlMail("xxxx@xxx.com","这是一封HTML邮件", content);
}

代码中拼接出的 HTML 的 String 字符串交给 MimeMessageHelper 来处理理,最后由邮件客户端负责渲染显示内容。

发送带附件的邮件

在 MailService 添加 sendAttachmentsMail 方法,发送带附件的邮件主要是使用 FileSystemResource 对文件进行封装,再添加到 MimeMessageHelper 中。

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 = file.getFilename();
        helper.addAttachment(fileName, file);

        // helper.addAttachment("test"+fileName, file);
        mailSender.send(message);
        logger.info("带附件的邮件已经发送。");
    } catch (MessagingException e) {
        logger.error("发送带附件的邮件时发生生异常!", e);
    }
}

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

在测试类中添加测试方法:

@Test
public void sendAttachmentsMail() {
    String filePath = "e:\\temp\\fastdfs-client-java-5.0.0.jar";
    mailService.sendAttachmentsMail("xxx@xx.com", "主题:带附件的邮件", "有附件,请查收!", filePath);
}

附件可以是图片、压缩包、Word 等任何文件,但是邮件厂商一般都会对附件大小有限制,太大的附件建议使用网盘上传后,在邮件中给出链接。

发送带静态资源的邮件

邮件中的静态资源一般指图片,在 MailService 中添加 sendInlineResourceMail 方法:

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 = "e:\\temp\\weixin.jpg";
    mailService.sendInlineResourceMail("xxxx@xxxx.com", "主题:这是有图片的邮件", content, imgPath, rscId);
}

添加多个图片可以使用多条 img src=‘cid:“+ rscId +”’ > 和 helper.addInline(rscId, res) 来实现。

蜗牛学苑_武汉
关注
  • 5
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot 整合邮件发送
死牛胖子的技术随笔
01-05 504
Spring boot 本身提供了 spring-boot-starter-mail 的 starter，用于集成邮件发送功能
基于SpringBoot整合RabbitMQ发送邮件通知
04-30
在微服务环境中，这样的邮件通知系统可以作为一个独立的服务存在，其他服务只需要发送消息到 RabbitMQ 的邮件队列即可触发邮件发送，实现了服务间的解耦。 总结来说，SpringBoot 结合 RabbitMQ 可以帮助我们构建...
springboot整合邮件发送
weixin_46146197的博客
06-29 496
老规矩，新建一个springboot项目 既然是邮件发送，那就有接收人，发件人，邮件内容，邮件主题，这几个是发送邮件的必要因素，所以我们可以定义一个实体类，属性就是这些。 项目结构大概这样：然后在pom文件引入依赖： service层代码： 从代码可以看出，从控制层传来一个email实体类就可以搞定一个简单的邮件发送。 控制层代码： 配置文件还需要配置： 重点说一下这个spring.mail.password，不是qq密码而是授权码，在哪里有呢？我告诉你： 然后启动项目，用postman测试： 成功：
springboot 整合 邮件发送
热门推荐
weixin_41849346的博客
12-22 9万+
pom依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency> 代码实现 import org.springframework.core.io.FileSystemResource; import o
Springboot整合邮件发送
zengqifeng1997的博客
06-23 301
1、依赖 <!-- 邮件发送包 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> <version>1.5.9.RELEASE</version>
SpringBoot整合邮件发送服务
记录一名在读研究生的学习笔记、感悟、开发产物
02-22 433
快速入门SpringBoot整合邮件发送服务
SpringBoot整合邮件发送功能
云丶言的博客
06-26 1332
此时文章我们将来讲述如何使用SpringBoot发送邮件。文章将从准备工作开始，解释邮件POP3/SMTP/IMAP功能和他们之间的区别，并使用其中一种方式来实现SpringBoot发送简单文本邮件、带有HTML属性的邮件、带有附件的邮件。
【springboot整合邮件发送】
m0_46601892的博客
04-27 310
【springboot整合邮件发送】
springboot整合邮件发送功能
秋枫萧竹的博客
03-30 906
一、开启QQ邮箱服务 二、初始化项目 三、发送简单邮件 四、发送复杂邮件 五、远程调用邮箱接口发送复杂邮件 总结
linux邮件发送springboot,SpringBoot整合邮件发送
weixin_39711721的博客
05-14 212
本节介绍SpringBoot项目如何快速配置和发送邮件，包括简单的邮件配置、发送简单邮件、发送HTML邮件、发送携带附件的邮件等。一、邮箱配置要确保使用的邮箱开启了客户端登录服务，以163邮箱为例： 注意在发送邮件的配置中，填写的用户名是邮箱地址，密码是这里的授权码。其他邮箱如QQ、企业邮箱也是类似的配置，不懂的建议百度哦，不是很复杂的。下面我们直接进入示例吧：二、简单邮件发送创建一个Sprin...
SpringBoot整合发送邮件
06-17
最后，我们可以通过调用`/send-email`接口来测试邮件发送功能。确保你的应用已经正确配置并运行，然后通过HTTP客户端向这个接口发送请求。 总结，Spring Boot整合发送邮件主要涉及以下几个步骤： 1. 添加`spring-...
SpringBoot整合ActiveMQ(消息中间件)实现邮件发送功能
12-30
在本项目中，"SpringBoot整合ActiveMQ(消息中间件)实现邮件发送功能"是一个典型的企业级应用示例，它展示了如何将SpringBoot框架与Apache ActiveMQ集成，以实现基于消息队列的邮件发送服务。下面我们将详细探讨这个...
springboot整合mail邮件发送
10-18
本文将深入探讨如何在Spring Boot项目中整合Mail服务，实现邮件发送功能。首先，我们需要理解Spring Boot的自动配置理念，它使得集成各种服务变得更加简单。邮件服务也不例外，Spring Boot提供了`spring-boot-...
SpringBoot整合邮箱JavaMail
08-15
在本文中，我们将深入探讨如何在SpringBoot应用中整合JavaMail服务，以便实现电子邮件的发送功能。SpringBoot作为一款轻量级的框架，提供了一种简单的方法来集成各种功能，包括邮件服务。JavaMail是Java平台上的标准...
springboot整合JavaMail，实现异步发送邮件功能
最新发布
06-24
创建好 Message 对象后， 只需要使用邮件发送API 得到 Transport 对象， 然后把 Message 对象传递给 Transport 对象， 并调用它的发送方法， 就可以把邮件发送给指定的邮件服务器。 (3)、Store 类 javax.mail....
springboot集成javamail实现发送邮件功能
02-13
springboot集成javamail，实现发送邮件的功能，可以发送文本类型邮件，也可以发送html格式的邮件，其中整合了mysql、mybatis 具体集成步骤可以参考我的文章： https://www.jianshu.com/p/668d320b4981
springboot整合jms进行邮件的发送
08-10
在本文中，我们将深入探讨如何使用Spring Boot与Java消息服务（JMS）来发送电子邮件，包括...通过配置邮件服务、创建邮件服务类、整合JMS模板以及创建生产者和消费者，我们可以构建一个高效、可扩展的邮件发送系统。
SpringBoot集成E-mail发送各种类型邮件
08-26
SpringBoot通过其内置的`spring-boot-starter-mail`模块提供了便捷的邮件发送功能，结合JDK的邮件API，我们可以轻松地实现邮件的发送。 首先，为了集成SpringBoot的邮件服务，我们需要在项目的`build.gradle`或`pom...
springboot整合发送邮件
08-17
# 邮件发送服务器主机名 spring.mail.host=your-smtp-server # 邮件发送服务器端口号 spring.mail.port=your-smtp-port # 邮件发送服务器用户名 spring.mail.username=your-username # 邮件发送服务器密码 spring....
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值