SpringBoot 实现发送邮件及工具类封装

已于 2023-04-18 16:47:54 修改
阅读量1k 收藏 7
点赞数 9
分类专栏： Java 随手记 文章标签： spring boot java 后端
于 2022-05-26 12:16:51 首次发布
原文链接：https://www.dandelioncloud.cn/article/details/1455436028873080834
版权

引言

文章摘自 蒲公英云-邮件工具类封装，仅提供学习、参考。

一、pom.xml 引入相关依赖

		<!--mail-->
		<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-mail</artifactId>
			<version>2.6.7</version>
		</dependency>

二、邮件 基本设置

spring:
  #配置邮箱
  mail:
    host: 邮箱服务商的protocol服务器主机 #smtp.qq.com 
    port: 465
    protocol: 邮件协议 #smtp
    username: 指定邮箱服务商的邮箱账号 #7557*****@qq.com
    nickname: 指定自定义发送人的昵称 #后台系统
    password: 邮箱账号密码或者三方登录授权码 #jwgteykojlf*****
    default-encoding:  UTF-8
    properties:
      mail:
        smtp:
          socketFactory:
            class: javax.net.ssl.SSLSocketFactory
        debug: true #调试模式
    test-connection: false #启动项目时验证是否可以正确通信 默认为false

三、发送邮件的Service接口

import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.MimeMessageHelper;

/**
 * 邮件发送
 */
public interface SendMailService {

	/**
	 * 发送文本
	 *
	 * @param subject     主题
	 * @param content     内容
	 * @param toWho       需要发送的人
	 * @param ccPeoples   需要抄送的人
	 * @param bccPeoples  需要密送的人
	 * @param attachments 需要附带的附件
	 */
	void sendSimpleTextMailActual(String subject, String content, String[] toWho, String[] ccPeoples, String[] bccPeoples, String[] attachments);

	/**
	 * 发送Html
	 *
	 * @param subject 主题
	 * @param content 内容
	 * @param toWho   需要发送的人
	 */
	void sendHtmlMail(String subject, String content, String[] toWho);

	/**
	 * 处理二进制邮件的基本信息，比如需要带附件的文本邮件、HTML文件、图片邮件、模板邮件等等
	 *
	 * @param mimeMessageHelper：二进制文件的包装类
	 * @param subject：邮件主题
	 * @param content：邮件内容
	 * @param toWho：收件人
	 * @param ccPeoples：抄送人
	 * @param bccPeoples：暗送人
	 * @param isHtml：是否是HTML文件，用于区分带附件的简单文本邮件和真正的HTML文件
	 * @return ：返回这个过程中是否出现异常，当出现异常时会取消邮件的发送
	 */
	boolean handleBasicInfo(MimeMessageHelper mimeMessageHelper, String subject, String content, String[] toWho, String[] ccPeoples, String[] bccPeoples, boolean isHtml);

	/**
	 * 用于填充简单文本邮件的基本信息
	 *
	 * @param simpleMailMessage：文本邮件信息对象
	 * @param subject：邮件主题
	 * @param content：邮件内容
	 * @param toWho：收件人
	 * @param ccPeoples：抄送人
	 * @param bccPeoples：暗送人
	 */
	void handleBasicInfo(SimpleMailMessage simpleMailMessage, String subject, String content, String[] toWho, String[] ccPeoples, String[] bccPeoples);

	/**
	 * 发送html
	 *
	 * @param subject：邮件主题
	 * @param content：邮件内容
	 * @param toWho：收件人
	 * @param mimeMessageHelper：二进制文件的包装类
	 */
	void handleBasicInfo(MimeMessageHelper mimeMessageHelper, String subject, String content, String[] toWho);

	/**
	 * 用于处理附件信息，附件需要 MimeMessage 对象
	 *
	 * @param mimeMessageHelper：处理附件的信息对象
	 * @param subject：邮件的主题，用于日志记录
	 * @param attachmentFilePaths：附件文件的路径，该路径要求可以定位到本机的一个资源
	 */
	void handleAttachment(MimeMessageHelper mimeMessageHelper, String subject, String[] attachmentFilePaths);
}

四、Service接口实现类

import lombok.RequiredArgsConstructor;
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.JavaMailSenderImpl;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Service;

import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.io.File;

/**
 * 邮件发送处理
 */
@Slf4j
@Service
@RequiredArgsConstructor
public class SendMailServiceImpl implements SendMailService {
	//邮件发送
	private final JavaMailSenderImpl mailSender;
	//默认编码
	public static final String DEFAULT_ENCODING = "UTF-8";
	//发件人邮箱
	@Value("${spring.mail.username}")
	private String username;
	//指定自定义发送人的昵称
	@Value("${spring.mail.nickname}")
	private String nickname;

	/**
	 * 发送文本
	 *
	 * @param subject     主题
	 * @param content     内容
	 * @param toWho       需要发送的人
	 * @param ccPeoples   需要抄送的人
	 * @param bccPeoples  需要密送的人
	 * @param attachments 需要附带的附件流（key：附件名称，value：附件流）
	 */
	@Override
	public void sendSimpleTextMailActual(String subject, String content, String[] toWho, String[] ccPeoples, String[] bccPeoples, String[] attachments) {
		//检验参数：邮件主题、收件人、邮件内容必须不为空才能够保证基本的逻辑执行
		if (subject == null || toWho == null || toWho.length == 0 || content == null) {
			log.error("邮件-> {} 无法继续执行，因为缺少基本的参数：邮件主题、收件人、邮件内容", subject);
			throw new RuntimeException("模板邮件无法继续发送，因为缺少必要的参数！");
		}
		log.info("开始发送简单文本邮件：主题->{}，收件人->{}，抄送人->{}，密送人->{}，附件->{}", subject, toWho, ccPeoples, bccPeoples, attachments);
		//附件处理，需要处理附件时，需要使用二进制信息，使用 MimeMessage 类来进行处理
		if (attachments != null && attachments.length > 0) {
			try {
				//附件处理需要进行二进制传输
				MimeMessage mimeMessage = mailSender.createMimeMessage();
				MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true, DEFAULT_ENCODING);
				//设置邮件的基本信息：这些函数都会在后面列出来
				boolean continueProcess = handleBasicInfo(helper, subject, content, toWho, ccPeoples, bccPeoples, false);
				//如果处理基本信息出现错误
				if (!continueProcess) {
					log.error("邮件基本信息出错: 主题->{}", subject);
					return;
				}
				//处理附件
				handleAttachment(helper, subject, attachments);
				//发送该邮件
				mailSender.send(mimeMessage);
				log.info("发送邮件成功: 主题->{}", subject);
			} catch (MessagingException e) {
				e.printStackTrace();
				log.error("发送邮件失败: 主题->{}", subject);
			}
		} else {
			//创建一个简单邮件信息对象
			SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
			//设置邮件的基本信息
			handleBasicInfo(simpleMailMessage, subject, content, toWho, ccPeoples, bccPeoples);
			//发送邮件
			mailSender.send(simpleMailMessage);
			log.info("发送邮件成功: 主题->{}", subject, toWho, ccPeoples, bccPeoples, attachments);
		}
	}

	/**
	 * 发送Html
	 *
	 * @param subject 主题
	 * @param content 内容
	 * @param toWho   需要发送的人
	 */
	@Override
	public void sendHtmlMail(String subject, String content, String[] toWho) {
		//检验参数：邮件主题、收件人、邮件内容必须不为空才能够保证基本的逻辑执行
		if (subject == null || toWho == null || toWho.length == 0 || content == null) {
			log.error("邮件-> {} 无法继续执行，因为缺少基本的参数：邮件主题、收件人、邮件内容", subject);
			throw new RuntimeException("模板邮件无法继续发送，因为缺少必要的参数！");
		}
		log.info("开始发送Html邮件：主题->{}，收件人->{}", subject, toWho);
		//html
		MimeMessage mimeMessage = mailSender.createMimeMessage();
		try {
			MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true, DEFAULT_ENCODING);
			//设置邮件的基本信息
			handleBasicInfo(helper, subject, content, toWho);
			//发送邮件
			mailSender.send(mimeMessage);
			log.info("html邮件发送成功");
		} catch (MessagingException e) {
			log.error("发送邮件出错->{}", subject);
		}
		log.info("发送邮件成功: 主题->{}", subject, toWho);
	}

	/**
	 * 处理二进制邮件的基本信息，比如需要带附件的文本邮件、HTML文件、图片邮件、模板邮件等等
	 *
	 * @param mimeMessageHelper：二进制文件的包装类
	 * @param subject：邮件主题
	 * @param content：邮件内容
	 * @param toWho：收件人
	 * @param ccPeoples：抄送人
	 * @param bccPeoples：暗送人
	 * @param isHtml：是否是HTML文件，用于区分带附件的简单文本邮件和真正的HTML文件
	 * @return ：返回这个过程中是否出现异常，当出现异常时会取消邮件的发送
	 */
	@Override
	public boolean handleBasicInfo(MimeMessageHelper mimeMessageHelper, String subject, String content, String[] toWho, String[] ccPeoples, String[] bccPeoples, boolean isHtml) {
		try {
			//设置必要的邮件元素
			//设置发件人
			mimeMessageHelper.setFrom(nickname + '<' + username + '>');
			//设置邮件的主题
			mimeMessageHelper.setSubject(subject);
			//设置邮件的内容，区别是否是HTML邮件
			mimeMessageHelper.setText(content, isHtml);
			//设置邮件的收件人
			mimeMessageHelper.setTo(toWho);
			//设置非必要的邮件元素，在使用helper进行封装时，这些数据都不能够为空
			if (ccPeoples != null)
				//设置邮件的抄送人：MimeMessageHelper # Assert.notNull(cc, "Cc address array must not be null");
				mimeMessageHelper.setCc(ccPeoples);
			if (bccPeoples != null)
				//设置邮件的密送人：MimeMessageHelper # Assert.notNull(bcc, "Bcc address array must not be null");
				mimeMessageHelper.setBcc(bccPeoples);
			return true;
		} catch (MessagingException e) {
			e.printStackTrace();
			log.error("邮件基本信息出错->{}", subject);
		}
		return false;
	}

	/**
	 * 用于填充简单文本邮件的基本信息
	 *
	 * @param simpleMailMessage：文本邮件信息对象
	 * @param subject：邮件主题
	 * @param content：邮件内容
	 * @param toWho：收件人
	 * @param ccPeoples：抄送人
	 * @param bccPeoples：暗送人
	 */
	@Override
	public void handleBasicInfo(SimpleMailMessage simpleMailMessage, String subject, String content, String[] toWho, String[] ccPeoples, String[] bccPeoples) {
		//设置发件人
		simpleMailMessage.setFrom(nickname + '<' + username + '>');
		//设置邮件的主题
		simpleMailMessage.setSubject(subject);
		//设置邮件的内容
		simpleMailMessage.setText(content);
		//设置邮件的收件人
		simpleMailMessage.setTo(toWho);
		//设置邮件的抄送人
		simpleMailMessage.setCc(ccPeoples);
		//设置邮件的密送人
		simpleMailMessage.setBcc(bccPeoples);
	}

	/**
	 * 发送html
	 *
	 * @param subject：邮件主题
	 * @param content：邮件内容
	 * @param toWho：收件人
	 * @param mimeMessageHelper：二进制文件的包装类
	 */
	@Override
	public void handleBasicInfo(MimeMessageHelper mimeMessageHelper, String subject, String content, String[] toWho) {
		try {
			//设置发件人
			mimeMessageHelper.setFrom(nickname + '<' + username + '>');
			//设置邮件的主题
			mimeMessageHelper.setSubject(subject);
			//设置邮件的内容
			mimeMessageHelper.setText(content, true);
			//设置邮件的收件人
			mimeMessageHelper.setTo(toWho);
		} catch (MessagingException e) {
			log.error("html邮件基本信息出错->{}", subject);
		}
	}

	/**
	 * 用于处理附件信息，附件需要 MimeMessage 对象
	 *
	 * @param mimeMessageHelper：处理附件的信息对象
	 * @param subject：邮件的主题，用于日志记录
	 * @param attachmentFilePaths：附件文件的字节流（key：附件名称，value：附件流）
	 */
	@Override
	public void handleAttachment(MimeMessageHelper mimeMessageHelper, String subject, String[] attachmentFilePaths) {
		//判断是否需要处理邮件的附件
		if (attachmentFilePaths != null && attachmentFilePaths.length > 0) {
			FileSystemResource resource;
			String fileName;
			//循环处理邮件的附件
			for (String attachmentFilePath : attachmentFilePaths) {
				//获取该路径所对应的文件资源对象
				resource = new FileSystemResource(new File(attachmentFilePath));
				//判断该资源是否存在，当不存在时仅仅会打印一条警告日志，不会中断处理程序。
				// 也就是说在附件出现异常的情况下，邮件是可以正常发送的，所以请确定你发送的邮件附件在本机存在
				if (!resource.exists()) {
					log.warn("邮件->{} 的附件->{} 不存在！", subject, attachmentFilePath);
					//开启下一个资源的处理
					continue;
				}
				//获取资源的名称
				fileName = resource.getFilename();
				try {
					//添加附件
					mimeMessageHelper.addAttachment(fileName, resource);
				} catch (MessagingException e) {
					e.printStackTrace();
					log.error("邮件->{} 添加附件->{} 出现异常->{}", subject, attachmentFilePath, e.getMessage());
				}
			}
		}
	}
}

五、测试方法

	@GetMapping("/sendmail")
	public void sendMail() {
		//邮件发送
		sendMailService.sendSimpleTextMailActual(
				//主题
				"这是一条测试主题",
				//内容
				"这是一条测试内容",
				//需要发送的人
				new String[]{"***@qq.com"},
				//需要抄送的人
				null,
				//需要密送的人
				null,
				//需要附带的附件
				new String[]{"C:/Users/zp/Desktop/test.txt"});
	}
王疏蔬
关注
  • 9
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
专栏目录
SpringBoot中封装jdbc工具类
04-08
现在的数据层的开发，大多会使用如MyBatis或JPA之类的开发工具。这些开发工具给我们的开发过程中带来了极大的便利。 但是在一些极端的场景下往往原生的jdbc方式操作数据库更灵活，性能更高。由于部分场景下MyBatis或JPA之类无法满足我的需求，所以我打算自己封装一套查数据库的工具类。 文章地址： https://blog.csdn.net/lxyoucan/article/details/124042295
封装自己的SDK
weixin_55166254的博客
11-11 2493
本文主要简单的示例如何创建自己的SDK依赖
手拉手spring-boot-starter-mail实现发送QQ邮箱
weixin_47268883的博客
02-05 521
手拉手spring-boot-starter-mail实现发送QQ邮箱
Springboot发送邮件
m0_67403073的博客
07-28 300
添加依赖。
JavaWEB用Spring内置的邮件封装类来发送邮件
Demorea的博客
01-15 643
在项目中经常会有类似这样的功能，注册账号需要验证（现在大多用的手机验证），但是绑定邮箱的时候也是需要验证的，这时候就需要用到邮件发送的功能，spring-context-support就有内置了一个邮件发送包装类，下面是发送邮件的一个简单实例的具体步骤。 1.准备两个邮箱，并且进行设置 首先准备两个邮箱，一个是用来发件的邮箱，一个是用来收件的邮箱。这里以QQ邮箱和新浪邮箱为例。我把QQ邮箱作为...
Spring Boot——基于spring-boot-starter-mail发送邮件的 Service 服务类DEMO
无限迭代中......
02-16 4583
前言 发送邮件应该是网站的必备拓展功能之一，注册验证，忘记密码或者是给用户发送营销信息。正常我们会用JavaMail相关api来写发送邮件的相关代码，但现在Spring Boot提供了一套集成spring-boot-starter-mail的更简易使用的封装。 基本概念 spring-boot-starter-mail： Spring框架提供了一个有用的实用程序库，用于发送电子邮件，使...
基于Spring封装的Javamail实现邮件发送
盲目的拾荒者的博客
10-16 1392
1.依赖 <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>4.1.5.RELEASE</version> </dependency&g...
用Spring的邮件封装类JavaMailSenderImpl发送邮件
热门推荐
李秀才的博客
03-31 3万+
JavaMailSenderImpl是spring封装的邮件发送封装类，支持普通文本、附件、html。博主今天用到了用qq邮箱发送普通文本，以后若用到了其他，再补充在下面。 用qq邮箱的smtp邮件服务器，前提之一是关闭登录保护，开启邮箱登录保护，无法使用smtp服务。若开启了，前往安全中心关闭。 前提之二是开启smtp服务，在邮箱的设置-账号设置-开启服务里查看是否开启了POP3
【JAVA】【入门向】| 使用Java发送邮箱【javax.mail】
Xunlan_博客
10-06 3391
【java】【入门向】在写一些项目时（比如涉及到账号需要找回），我们不可避免需要用上邮件，就跟随我学习使用java自动发送邮件吧。（使用javax.mail）
SpringBoot实现邮件发送及其工具类封装
晓得哪个的博客
09-14 8837
SpringBoot邮件发送工具类 环境：JDK8、IDEA 依赖：SpringBoot-1.5.10、spring-boot-starter-mail、spring-boot-starter-thymeleaf、spring-boot-starter-web 说明：当在本博客里面遇见不清楚的地方时，请移步其他资源补充相关知识，这里只是介绍我封装的一个邮件发送工具类而已（没...
SpringBoot for MimeMessageHelper 发送邮件
weixin_43650943的博客
02-25 3434
SpringBoot、MimeMessageHelper、发送邮件、多个附件上传
java一键发送邮件，封装好的工具类
10-10
java邮件发送的工具类，方法都已封装好，一键调用即可发送，支持普通文本邮件，支持带有附件的邮件，支持html代码的邮件内容
springboot封装JsonUtil,CookieUtil工具类代码实例
10-16
主要介绍了springboot封装JsonUtil,CookieUtil工具类过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Springboot实现多线程注入bean的工具类操作
09-07
主要介绍了Springboot实现多线程注入bean的工具类操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
springboot 集成封装redis工具类redisUtils和单元测试
09-13
文章是redisUtils工具类的封装，和基于springboot环境的单元测试； 文中封装了redis的众多方法，希望对您有所帮助。
Spring Boot的热部署工具“AND”Swagger测试工具
最新发布
闲来垂钓碧溪上的博客
04-30 738
指的是在项目无需重启的情况下，只需要刷新页面，即可获得已经修改的样式或功能。要注意该工具一般用于开发环境，在生产环境中最好不要添加这个工具。对于无需重启便可刷新这么方便的工具，在项目中该如何使用：在spring boot 项目中使用工具的方法就是引入相关依赖，热部署工具的依赖如下：
Spring boot 应用引入 Spring cloud alibaba nacos
ttyy1112的专栏
04-30 1174
通过这些步骤，您的Spring Boot应用就可以成功引入Spring Cloud Alibaba的依赖，并且使用Nacos作为服务发现和配置中心。要在Spring Boot应用中引入Spring Cloud Alibaba的依赖以及Nacos的依赖，您可以按照以下步骤在。通过上述步骤，你可以使用OpenFeign轻松地调用远程服务。如果使用tomcat方式启动应用，应用无法自动注册到nacos，可参考。运行你的应用程序，它将会自动注册到Nacos注册中心。注解，以启用Nacos服务注册功能。
# 使用 spring boot 时，@Autowired 注解 自动装配注入时，变量报红解决方法：
段子手168的博客
04-29 652
# 使用 spring boot 时，@Autowired 注解 自动装配注入时，变量报红解决方法：
Spring Boot Admin
qq_34020761的博客
04-27 687
Spring Boot Admin用于监控线上所有Spring Boot应用的健康状况，提供实时警报功能~
springboot发送post请求封装工具类
03-29
以下是一个简单的封装工具类，用于发送POST请求： ``` import org.springframework.http.HttpEntity; import org.springframework.http.HttpHeaders; import org.springframework.http.MediaType; import org....

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值