SpringBoot整合Mail（发送电子邮件）

版权声明：本文为 小异常 原创文章，非商用自由转载-保持署名-注明出处，谢谢！
本文网址：https://sunkuan.blog.csdn.net/article/details/112708385

本篇博客主要总结 Spring Boot 整合 Mail 来实现发送电子邮件。本篇会以一个 Demo 为例，以 Spring Boot 为基础架构，不涉及其他技术来实现发送电子邮件，方便初学者学习整理。
　
其实早在 Java 发明之初，就开发支持发送电子邮件了，通过 Java Mail 包方式去操作邮件发送的内容和协议，但是，这种发送方式稍微比较复杂，需要配置各种参数、协议、内容。后来 Spring 横空出世后，Spring 在 Java Mail 的基础上进行了一些封装，使发送邮件过程的复杂度大大减少。Spring Boot Mail 在 Spring Mail 的基础上，再次进行了一次封装，使得发送邮件的便利度上，更为简单。
　
本篇博客以 126 邮箱为例讲解如何用程序发送电子邮件，而其他邮箱只是界面上按钮位置不同，其他都基本一致。

---

一、具体操作

1、准备工作

1）Maven 依赖

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

2）邮箱账号

我们需要准备一个邮箱账号来充当邮箱服务器，我就以自己的 126 邮箱进行演示，先进入邮箱，选择设置，找到 POP3/SMTP服务 相关配置（POP3 协议是收取邮件，SMTP 协议是发送邮件），我们需要把这个服务开启。

注意：我们要记住这个授权码，它很关键！！

2、配置文件（application.yml）

spring:
	mail:
		host: smtp.126.com  # smtp邮箱服务配置
		username: xxxx@126.com  # 上面我们配置好的 126 邮箱
		password: xxx  # 注意这里不是邮箱密码，而是 SMTP 授权密码
		post: 465
		protocol: smtps
		default-encoding: UTF-8

3、业务代码实现

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.Service;

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

@Service
public class MailService {
    
	/** 发送邮件的邮箱 */
	@Value("${spring.mail.username}")
	private String from;

	/** Java发送者 */
	@Autowired
	private JavaMailSender mailSender;

	/**
	 * 1. 简单文本邮件
	 * @param to 接收者邮件
	 * @param subject 邮件主题
	 * @param contnet 邮件内容
	 */
	public void sendSimpleMail(String to, String subject, String contnet){
		// 简单的邮件消息
		SimpleMailMessage message = new SimpleMailMessage();
		message.setTo(to); // 设置接收者
		message.setSubject(subject); // 设置邮件主题
 		message.setText(contnet); // 设置邮件内容
		message.setFrom(from);  // 设置发送者

		mailSender.send(message); // 发送消息
	}

	/**
	 * 2. HTML 文本邮件
	 * @param to 接收者邮件
	 * @param subject 邮件主题
	 * @param contnet HTML内容
	 * @throws MessagingException
	 */
	public void sendHtmlMail(String to, String subject, String contnet) throws MessagingException {
		// 扩展的邮件消息（HTML文本）
		MimeMessage message = mailSender.createMimeMessage();

		MimeMessageHelper helper = new MimeMessageHelper(message, true);
 		helper.setTo(to);
		helper.setSubject(subject);
		helper.setText(contnet, true);
		helper.setFrom(from);

		mailSender.send(message);
	}

	/**
	 * 3. 附件邮件
	 * @param to 接收者邮件
	 * @param subject 邮件主题
	 * @param contnet HTML内容
	 * @param filePath 附件路径
	 * @throws MessagingException
	 */
	public void sendAttachmentsMail(String to, String subject, String contnet,
				String filePath) throws MessagingException {
		MimeMessage message = mailSender.createMimeMessage();

		MimeMessageHelper helper = new MimeMessageHelper(message, true);
		helper.setTo(to);
		helper.setSubject(subject);
		helper.setText(contnet, true);
		helper.setFrom(from);

		// 文件系统资源
		FileSystemResource file = new FileSystemResource(new File(filePath));
		String fileName = file.getFilename();
		helper.addAttachment(fileName, file);

		mailSender.send(message);
	}

	/**
	 * 4. 图片邮件
	 * @param to 接收者邮件
	 * @param subject 邮件主题
	 * @param contnet HTML内容
	 * @param rscPath 图片路径
	 * @param rscId 图片ID
	 * @throws MessagingException
	 */
	public void sendInlinkResourceMail(String to, String subject, String contnet,
				String rscPath, String rscId) {
		MimeMessage message = mailSender.createMimeMessage();
		MimeMessageHelper helper = null;

		try {
			helper = new MimeMessageHelper(message, true);
			helper.setTo(to);
			helper.setSubject(subject);
			helper.setText(contnet, true);
			helper.setFrom(from);

			FileSystemResource res = new FileSystemResource(new File(rscPath));
			helper.addInline(rscId, res);
			mailSender.send(message);
			System.out.println("发送静态邮件成功!");
		} catch (MessagingException e) {
			System.out.println("发送静态邮件失败: ", e);
		}

	}
}

---

二、测试发送邮件

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;

import javax.annotation.Resource;
import javax.mail.MessagingException;

@RunWith(SpringRunner.class)
@SpringBootTest
public class MailServiceTest {
	
	@Autowired
	private MailService mailService;

	@Resource
	private TemplateEngine templateEngine;
	
	// 1. 测试简单邮件
	@Test
	public void sendSimpleMail() {
		mailService.sendSimpleMail("xxx@qq.com", "测试spring boot imail-主题", "测试spring boot imail - 内容");
	}

	// 2. 测试html邮件
	@Test
	public void sendHtmlMail() throws MessagingException {
		String content = "<html>\n" +
				"<body>\n" +
				"<h3>hello world</h3>\n" +
				"<h1>html</h1>\n" +
				"<body>\n" +
				"</html>\n";
		mailService.sendHtmlMail("xxx@qq.com", "这是一封HTML邮件", content);
	}

	// 3. 测试附件邮件
	@Test
	public void sendAttachmentsMail() throws MessagingException {
		String filePath = "/ijiangtao/软件开发前景.docx";
		String content = "<html>\n" +
				"<body>\n" +
				"<h3>hello world</h3>\n" +
				"<h1>html</h1>\n" +
				"<h1>附件传输</h1>\n" +
				"<body>\n" +
				"</html>\n";
		mailService.sendAttachmentsMail("xxx@qq.com", "这是一封附件邮件", content, filePath);
	}

	// 4. 测试图片邮件
	@Test
	public void sendInlinkResourceMail() throws MessagingException {
		// 改为本地图片目录
		String imgPath = "/blog/animal/dog/dog-at-work-with-computer-2.jpg";
		String rscId = "admxj001";
		String content = "<html>" +
				"<body>" +
				"<h3>hello world</h3>" +
				"<h1>html</h1>" +
				"<h1>图片邮件</h1>" +
				"<img src='cid:"+rscId+"'></img>" +
				"<body>" +
				"</html>";
		mailService.sendInlinkResourceMail("xxx@qq.com", "这是一封图片邮件", content, imgPath, rscId);
	}
	
}

博客中若有不恰当的地方，请您一定要告诉我。前路崎岖，望我们可以互相帮助，并肩前行！