【发邮件】SpringBoot 通过 hutool 方式发送邮件

最新推荐文章于 2024-07-28 13:56:45 发布
最新推荐文章于 2024-07-28 13:56:45 发布
阅读量4.9k 收藏 12
点赞数 3
分类专栏： 项目工具类 文章标签： spring spring boot redis swagger2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_35394434/article/details/119969435
版权
本文档详细介绍了如何在SpringBoot项目中使用Hutool库发送邮件，包括设置SMTP授权码、发送带验证码的邮件、设置邮件模板以及通过Redis缓存验证码。项目代码托管于码云，包含异步发送邮件的实现和邮件配置类的详细说明。
摘要由CSDN通过智能技术生成

SpringBoot 通过 hutool 方式发送邮件

本文的码云地址：点击传送

本文项目效果：

  1. 发送普通邮件
  2. 发送随机验证码邮件并把验证码缓存到redis
  3. 发送带格式模板的邮件

本项目代码都在码云里，传送门在上面，我这里把几个重点的地方详讲一下，所贴代码会删减一部分不重要的，以便阅读

1. 项目结构

在这里插入图片描述


2. 项目配置

application.yml

【注意】如果是腾讯个人qq邮箱，这里的密码不是邮箱登录密码，而是授权码，否则将会出现密码不对的情况。
授权码：网页QQ邮箱 > 设置 > 账户 > POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服务 > 开启STMP并获得授权码

server:
  port: 8080

#邮箱验证码有效时间/秒
code:
  expiration: 300

# 电子邮件配置
# 如果是腾讯个人qq邮箱，这里的密码不是邮箱登录密码，而是授权码：
# 授权码：网页QQ邮箱 > 设置 > 账户 > POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服务 > 开启STMP并获得授权码
email:
  host: smtp.qiye.aliyun.com # SMTP地址
  port: 465
  from: 昵称<xxx@xxx.com> # 发件人昵称
  pass: xxxxxx
  user: xxx@xxx.com # 邮箱地址

# 验证码有效时长(秒)
verification:
  expiration-time: 600

spring:
  redis:
    database: 2
    host: xxx.xxx.xxx.xxx
    port: xxxxx
    password: xxxxxx
    timeout: 10000ms

#是否开启 swagger-ui
swagger:
  enabled: true



3. 邮件配置类 EmailConfig.java

这个配置类从上面的配置文件中读取数据填入到属性中。

import io.swagger.annotations.ApiModelProperty;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import javax.persistence.Entity;

@Component
public class EmailConfig {

    /**
     * 发送方 邮件服务器 SMTP 地址
     */
    @Value("${email.host}")
    @ApiModelProperty(value = "发送方 邮件服务器SMTP地址")
    private String host;

    /**
     * 发送方 邮件服务器 SMTP 端口
     */
    @Value("${email.port}")
    @ApiModelProperty(value = "发送方 邮件服务器 SMTP 端口")
    private String port;

    /**
     * 发送方 昵称
     */
    @Value("${email.from}")
    @ApiModelProperty(value = "发送方 昵称")
    private String from;

    /**
     * 发送方 密码
     */
    @Value("${email.pass}")
    @ApiModelProperty(value = "发送方 密码")
    private String pass;

    /**
     * 发送方 邮箱地址
     */
    @Value("${email.user}")
    @ApiModelProperty(value = "发送方 邮箱地址")
    private String user;

	//--TODO 此处省略 Get、Set 方法
}

【注意1】这个类需要加 @Component 注解才能被 Spring 扫描到
【注意2】这个类直接 new 时，属性中的值是空的，是因为被 new 是我们主动创建而不是被 Spring 创建出来的，所以属性值并没有被注入。所以我们需要在使用时使用 @Autowired 注解，被 Spring 托管。

本项目中，采用了一个巧妙的方式，即：该配置类可外部设置并以参数形式传入，如果该参数为null，那么这个配置就有 Spring 负责注入配置文件的数据，等会儿在下方的 4【EmailServiceImpl.java】就能看到。



4. 邮件逻辑层实现层 EmailServiceImpl.java

  1. 当邮件发送模块没有问题并作为工具被使用时，建议使用异步执行，这样有效的降低请求的响应时间。
  2. 发件邮箱配置可外部参数传入，是为了方便上层使用其他邮箱作为发送方预留的
@Service
public class EmailServiceImpl implements EmailService {

    /**
     * 验证码有效时长(秒)
     */
    @Value("${verification.expiration-time}")
    private Long expirationTime;

    @Autowired
    private RedisUtils redisUtils;

	// 这里就是交由 Spring 托管的配置类，为默认配置
    @Autowired
    private EmailConfig defaultConfig;

	/**
     * 发送邮件
     * @param emailVo 邮件发送的内容
     * @param emailConfig 邮件配置，null:使用默认配置
     * @throws Exception /
     */
    @Override
    @Async // 发送邮件为异步执行
    @Transactional(rollbackFor = Exception.class)
    public void send(EmailVo emailVo, EmailConfig emailConfig) {
    	// 这里可以选择使用外部传入的配置，如果外部传入为null，那么便使用默认配置。
        if(emailConfig == null) {
            emailConfig = defaultConfig;
        } else if (StringUtils.isBlank(emailConfig.getHost()) || StringUtils.isBlank(emailConfig.getPort())
                || StringUtils.isBlank(emailConfig.getFrom()) || StringUtils.isBlank(emailConfig.getPass())
                || StringUtils.isBlank(emailConfig.getUser())) {
            throw new BadConfigurationException("请先配置邮箱数据，再操作!");
        }

        MailAccount account = new MailAccount();
        // 发件人昵称
        account.setFrom(emailConfig.getFrom());
        // 发件人邮箱地址
        account.setUser(emailConfig.getUser());
        account.setHost(emailConfig.getHost());
        account.setPort(Integer.parseInt(emailConfig.getPort()));

        account.setAuth(true);
        account.setPass(emailConfig.getPass());

        // ssl 方式发送
        account.setSslEnable(true);
        // 使用STARTTLS 安全连接
        account.setStarttlsEnable(true);
        // 发送
        try {
           int size = emailVo.getTos().size();
            Mail.create(account)
                    .setTos(emailVo.getTos().toArray(new String[size]))
                    .setTitle(emailVo.getSubject())
                    .setContent(emailVo.getContent())
                    .setHtml(true)
                    // 关闭session
                    .setUseGlobalSession(false)
                    .send();
        } catch (Exception e) {
            throw new BadRequestException(e.getMessage());
        }
    }

	/**
     * 获取验证码的邮件参数类
     * @param toEmail 目标邮箱
     * @return
     */
    @Override
    @Transactional(rollbackFor = Exception.class)
    public EmailVo getVerificationCodeEmailVo(String toEmail) {
        String content;
        String redisKey = EmailCodeEnum.VERIFICATION_CODE.getKey() + toEmail;

        TemplateEngine engine = TemplateUtil.createEngine(new TemplateConfig("template", TemplateConfig.ResourceMode.CLASSPATH));
        Template template = engine.getTemplate("email/verificationCode.ftlh");
        Object oldCode = redisUtils.get(redisKey);

        // 如果Redis不存在有效验证码，就创建一个新的
        // 存在就使用原来的验证码，并将有效期更新
        if (oldCode == null) {
            String code = RandomUtil.randomNumbers(6); // 6位验证码，修改这里可以更改位数
            // 存入缓存
            boolean saveResult = redisUtils.set(redisKey, code, expirationTime);
            if(!saveResult) {
                throw new RedisException("Redis服务异常! 验证码未保存成功!");
            }
            content = template.render(Dict.create().set("code", code));
        } else {
        	// 重置Redis中这个key的有效期
            redisUtils.expire(redisKey, expirationTime);
            content = template.render(Dict.create().set("code", oldCode));
        }
        return new EmailVo(Collections.singletonList(toEmail), "Hutool-" + EmailCodeEnum.VERIFICATION_CODE.getDescription(), content);
    }

	/**
     * 获取简单通知的邮件参数类
     * @param toEmail 目标邮箱
     * @return
     */
    @Override
    @Transactional(rollbackFor = Exception.class)
    public EmailVo getSimpleNotificationEmailVo(String toEmail, String msg) {
        String redisKey = EmailCodeEnum.VERIFICATION_CODE.getKey() + toEmail;
        TemplateEngine engine = TemplateUtil.createEngine(new TemplateConfig("template", TemplateConfig.ResourceMode.CLASSPATH));
        Template template = engine.getTemplate("email/simple_notification.ftlh");
        String content = template.render(Dict.create().set("msg", msg));
        return new EmailVo(Collections.singletonList(toEmail), "Hutool-" + EmailCodeEnum.NOTIFICATION.getDescription(), content);
    }
}



5. 邮件控制层 EmailController.java

很显然，控制器没什么好讲的~

如果代码写的很完善了，那么代码中的很多校验都可以删除或者放到前端，比如：判断目标邮箱、邮件标题等不为空等。

@RestController
@RequestMapping("api/email")
@Api(tags = "工具：邮件管理")
public class EmailController {

    @Autowired
    private EmailService emailService;

    /**
     * 发送邮件
     * @param toEmail 目标邮箱
     * @param subject 邮件标题
     * @param content 邮件内容
     * @return
     */
    @PostMapping("/sendMail")
    public String SendEmail(@RequestParam String toEmail, @RequestParam String subject, @RequestParam String content){
        if(StringUtils.isBlank(toEmail)) {
            throw  new BadRequestException("目标邮箱不能为空！");
        }
        if(StringUtils.isBlank(subject)) {
            throw new BadRequestException("邮件标题不能为空！");
        }
        if(StringUtils.isBlank(content)) {
            throw new BadRequestException("邮件内容不能为空！");
        }
        List<String> toEmails = new ArrayList<>();
        toEmails.add(toEmail);
        EmailVo emailVo = new EmailVo(toEmails, subject, content);
        emailService.send(emailVo, null);
        return "邮件已发送！";
    }

    /**
     * 发送验证码
     * @param toEmail 目标邮箱
     * @return
     */
    @PostMapping("/sendVerificationCode")
    public String SendVerificationCode(@RequestParam String toEmail) {
        EmailVo emailVo = emailService.getVerificationCodeEmailVo(toEmail);
        emailService.send(emailVo, null);
        return "邮件已发送！";
    }

    /**
     * 发送验证码
     * @param toEmail 目标邮箱
     * @param msg 通知的信息
     * @return
     */
    @PostMapping("/sendSimpleNotification")
    public String SendSimpleNotification(@RequestParam String toEmail, @RequestParam String msg) {
        if(StringUtils.isBlank(msg)) {
            throw new BadRequestException("通知信息为空！");
        }
        EmailVo emailVo = emailService.getSimpleNotificationEmailVo(toEmail, msg);
        emailService.send(emailVo, null);
        return "邮件已发送！";
    }
}
散场前的温柔
关注
专栏目录
利用hutool实现邮件发送功能
猿小白的博客
01-15 7853
如何利用hutool工具包实现邮件发送功能呢？ 1、首先引入hutool依赖 <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.7.19</version> </dependency> 2、编写邮件发送工具类 package com.pc.c...
MailUtil 邮箱发送
最新发布
javaxueba的博客
09-13 258
本文使用的是HuTool工具类发送邮件：邮件工具-MailUtil | Hutool。
Hutool工具发送邮件 send Email
编程语言与各种框架(Java,python)
05-01 902
通过Hutool工具内部封装的 send Email 来简化发送邮件的代码逻辑。
邮件工具-MailUtil(发送邮件)
热门推荐
qq_38795959的博客
03-22 2万+
邮件工具-MailUtil 概述 在Java中发送邮件主要品依靠javax.mail包，但是由于使用比较繁琐，因此Hutool针对其做了封装。由于依赖第三方包，因此将此工具类归类到extra模块中。 使用 引入依赖 Hutool对所有第三方都是可选依赖，因此在使用MailUtil时需要自行引入第三方依赖。 <dependency> <groupId>j...
hutool 发送邮件
cjh的博客
04-16 448
1、导入依赖 <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>4.5.15</version> </dependency> <dependency> <groupId>javax.mail</groupId> &
用hutool实现邮件发送功能
weixin_57393819的博客
06-30 4950
用 hutool 工具包实现发送邮件的详细步骤 ~
【Java】Hutool发送邮件功能
程序猿学社的博客
06-04 631
通过hutool工具类发送验证码
Springboot使用Hutool邮件工具发送邮箱验证码
qq_43620423的博客
03-14 1923
一、引入依赖 因为Hutool对于第三方工具都是可选依赖，所以除了Hutool依赖还需要引入MailUtil的依赖 <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.5.0</version> </dependency> <dependency>
SpringBoot学习笔记（七）——邮件发送与SpringBoot其他框架
Harrison的学习博客
06-25 667
通过了解其他的SpringBoot框架，我们就可以在我们自己的Web服务器上实现更多更高级的功能。我们在注册很多的网站时，都会遇到邮件或是手机号验证，也就是通过你的邮箱或是手机短信去接受网站发给你的注册验证信息，填写验证码之后，就可以完成注册了，同时，网站也会绑定你的手机号或是邮箱。那么，像这样的功能，我们如何实现呢？SpringBoot已经给我们提供了封装好的邮件模块使用： 邮件发送 在学习邮件发送之前，我们需要先了解一下什么是电子邮件。电子邮件也是一种通信方式，是互联网应用最广的服务。通过网络的电子邮件
Java邮件发送基于springboot实现
小小程序员
09-21 2216
Java邮件发送基于springboot实现邮件发送相关版本下面是相关代码整理邮件发送接口MailService邮件发送实现代码MailServiceImpl封装的邮件实体EmailMsg邮件模板，.ftl文件最后一点，邮件发送者配置完结 基于springboot实现邮件发送 基于spring-boot-starter-mail实现，普通邮件发送无需额外依赖引入，因我所使用功能涉及模板发送，所以还需要引入spring-boot-starter-freemarker依赖。 相关版本 springboot：2.
springboot发送邮件报AuthenticationFailedException 334异常
Fighting_YY的博客
11-20 2505
一、相关配置&代码 springboot pom文件配置，将自动导入javax.mail-1.6.2.jar <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency> yaml文件配置如下 spring： mail.
Springboot使用Hutool工具类实现邮件发送
qq_46788415的博客
02-02 1309
Springboot使用Hutool工具类实现邮件发送
功能实现——采用 Hutool 工具发送邮件
代码星辰的博客
07-28 1858
本文介绍了如何使用 Hutool 工具发送邮件。
【JAVA】【Hutool】一行代码完成邮箱发送
南方者的博客
10-08 246
目录【所需添加的依赖】【配置文件】【代码与结果展示】 【所需添加的依赖】 <!-- hutool 一个Java基础工具类，对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装，组成各种Util工具类 --> <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.7
利用hutool工具包发送qq邮件，亲测有效
qq_44871403的博客
06-20 1417
利用hutool工具包发送qq邮件，亲测有效
springboot整合hutool发送邮件
K的博客
07-27 871
springboot整合hutool发邮件
Java根据Hutool发送邮件(个人、企业)
weixin_49997433的博客
11-03 439
Java发送企业邮件、可附带附件。
【Java】【Hutool】从零开始实现发送邮件功能
like_start的博客
12-19 1747
因为qq是遵循安全协议的ssl = 1，所以设置的端口选择：465。
发送邮件，如何使用java发邮件HuTool发送邮件
Xuhaitao的博客
06-17 1922
邮件发送 事先准备一个邮箱（最好不要使用QQ，以新浪为例） 申请一个邮箱 开启客户端授权（新浪为例） 开启时会给你的手机发送一个验证码然后给你一串密码提示此密码只给一次记好这个密码 打开IDE创建springboot项目（其他java项目也是可以） 导入相关依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boo
hutool整合springboot
09-16
在SpringBoot中整合Hutool可以通过以下步骤实现： 1. 首先，将Hutool的依赖添加到你的项目的pom.xml文件中： ```xml <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.8.5</version> </dependency> ``` 2. 在你的SpringBoot应用程序中，可以直接使用Hutool提供的各种工具类，例如字符串工具类、日期工具类、文件工具类等等。你可以通过在需要使用Hutool的地方引入相应的类并调用其方法来使用它们。 3. 如果你需要整合Hutool的邮件工具类，并与SpringBoot一起使用，你需要添加javax.mail的依赖到你的项目的pom.xml文件中： ```xml <dependency> <groupId>com.sun.mail</groupId> <artifactId>javax.mail</artifactId> <version>1.6.2</version> </dependency> ``` 4. 接下来，你可以在classpath下的config目录（在标准Maven项目中为src/main/resources）中创建一个mail.setting文件，用于配置邮件发送的相关信息。 5. 最后，你可以在需要发送邮件的地方调用Hutool提供的邮件工具类，使用配置好的邮件配置信息发送邮件。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值