Spring Boot 整合 JavaMail
- 1. 简述
- 2. 基础整合使用
  - 2.1. 引入依赖
  - 2.2. 邮件参数配置
配置邮箱
发送邮件相关参数
发送邮件相关参数
- 7. （!待整理）邮件系统
- 8. 其他

Spring Boot 整合 JavaMail

1. 简述

本笔记基于Spring Boot 2.1.2 版本进行开发
发送邮件应该是网站的必备功能之一，什么注册验证，忘记密码或者是给用户发送营销信息。最早期的时候会使用 JavaMail 相关 api 来写发送邮件的相关代码，后来 Spring 推出了 JavaMailSender 更加简化了邮件发送的过程，在之后 Spring Boot 对此进行了封装就有了现在的 spring-boot-starter-mail

2. 基础整合使用

2.1. 引入依赖

在Spring Boot中发送邮件，在 pom.xml 文件里面添加 spring-boot-starter-mail 包引用

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

2.2. 邮件参数配置

在 application.yml 中添加邮箱配置参数 ``` spring:
配置邮箱
mail: host: smtp.126.com # 邮箱服务器地址 username: lje888@126.com # 邮箱账号 password: ** # 密码 default-encoding: utf-8 # 默认编码

发送邮件相关参数

mail: fromMail: address: lje888@126.com


- application.properties 配置（日后补充）

### 2.3. 编写接口与测试
1. 编写 mailService 接口与实现类

public interface MailService { /**

 * 发送简单邮件
 *
 * @param to      目标邮箱
 * @param subject 邮件主题
 * @param content 邮件内容
 */
void sendSimpleMail(String to, String subject, String content);

}

@Service public class MailServiceImpl implements MailService {

private static final Logger LOGGER = LoggerFactory.getLogger(MailService.class);
/* 注入邮件发送类 */
@Autowired
private JavaMailSender javaMailSender;
/* 读取配置文件邮件发送地址 */
@Value("${mail.fromMail.address}")
private String from;
/**
 * 发送简单邮件
 *
 * @param to      目标邮箱
 * @param subject 邮件主题
 * @param content 邮件内容
 */
@Override
public void sendSimpleMail(String to, String subject, String content) {
    // 创建邮件对象
    SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
    // 设置邮件相关参数
    simpleMailMessage.setFrom(from);
    simpleMailMessage.setTo(to);
    simpleMailMessage.setSubject(subject);
    simpleMailMessage.setText(content);
    // 发送邮件
    javaMailSender.send(simpleMailMessage);
    LOGGER.info("发送简单邮件成功");
}

}


2. 编写 test 类测试

@RunWith(SpringRunner.class) @SpringBootTest(properties = {“activeName=dev”}) public class MailSendTest {

/* 注入邮件服务接口 */
@Autowired
private MailService mailService;
@Test
public void testSendSimpleMail() {
    mailService.sendSimpleMail("lje888@126.com", "测试发送邮件", "hello JavaMail for Spring boot");
}

}

## 3. 发送 html 格式邮件
1. 其他配置不需要改

/**

发送 html 格式邮件 *
@param to 目标邮箱
@param subject 邮件主题

@param content 邮件内容 */ @Override public void sendHtmlMail(String to, String subject, String content) { // 创建MimeMessage邮件对象 MimeMessage mimeMessage = javaMailSender.createMimeMessage();

try {

 // 参数true表示需要创建一个multipart message
 MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
 mimeMessageHelper.setFrom(from);
 mimeMessageHelper.setTo(to);
 mimeMessageHelper.setSubject(subject);
 // 第二参数表示内容是否为html文本
 mimeMessageHelper.setText(content, true);
 // 发送邮件
 javaMailSender.send(mimeMessage);
 LOGGER.info("发送简单邮件成功");

} catch (MessagingException e) {

 e.printStackTrace();
 LOGGER.debug("发送 html 格式邮件失败，{}", e.getMessage());

} }


2. 测试

@Test public void testHtmlMail() { String content = “\n” + “\n” + “

hello world ! 这是一封Html邮件!

\n” + “\n” + ““; mailService.sendHtmlMail(“lje888@126.com”, “测试发送Html邮件”, content); }

## 4. 发送带附件的邮件
1. 本示例是指定一个上传的文件夹，将文件夹中所有文件作为附件上传，一个文件一封邮件
1. 配置application.yml文件，设置上传文件夹

发送邮件相关参数

mail: fromMail: address: eric_ending@126.com uploadPath: E:\01-暂存处理区\風雲漫畫\不同步\待上传\autoUpload\


3. 编写上传附件的邮件接口与实现类

/**

发送带附件的邮件 *
@param to 目标邮箱
@param subject 邮件主题
@param content 邮件内容

@param fileList 邮件附件对象数组 */ @Override public void sendAttachmentsMail(String to, String subject, String content, File[] fileList) { // 设置系统参数，取消发送邮件附件名称长度限制 System.setProperty(“mail.mime.splitlongparameters”, “false”);

if (fileList != null && fileList.length > 0) {

 try {
     for (File filePath : fileList) {
         // 创建MimeMessage邮件对象
         MimeMessage mimeMessage = javaMailSender.createMimeMessage();
         // 参数true表示需要创建一个multipart message
         MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true, "UTF-8");
         mimeMessageHelper.setFrom(from);
         mimeMessageHelper.setTo(to);
         mimeMessageHelper.setText(content, true);
         // 读取文件
         FileSystemResource fileSystemResource = new FileSystemResource(filePath);
         // 获取文件名称
         String fileName = fileSystemResource.getFilename();
         // 设置附件，添加多个附件可以使用多条 helper.addAttachment(fileName, file)
         mimeMessageHelper.addAttachment(MimeUtility.encodeWord(fileName, "UTF-8", "B"), fileSystemResource);
         // 判断是否有主题名称，如果主题为空，则以文件名称做为邮件主题名称
         if (StringUtils.isBlank(subject)) {
             mimeMessage.setSubject(fileName);
         } else {
             mimeMessageHelper.setSubject(subject);
         }
         // 发送邮件
         javaMailSender.send(mimeMessage);
         LOGGER.info("{}邮件发送成功", fileName);
     }
 } catch (Exception e) {
     e.printStackTrace();
     LOGGER.debug("发送附件邮件失败，{}", e.getMessage());
 }

} }

@Override public void sendAttachmentsMail(String to, File[] fileList) { this.sendAttachmentsMail(to, “”, “”, fileList); }


4. 测试方法

/ 附件上传文件存储路径 / @Value(“${mail.uploadPath}”) private String uploadPath;

@Test public void sendAttachmentsMail() { // 读取配置文件，获取上传文件夹对象 File file = new File(uploadPath);

// 判断是否为文件夹
if (file.isDirectory()) {
    // 获取文件夹所有文件名称
    File[] fileList = file.listFiles();
    mailService.sendAttachmentsMail("eric_ending@126.com", fileList);
}

}

## 5. 发送带静态资源的邮件
发送带静态资源的邮件其实就是在发送HTML邮件的基础上嵌入静态资源（比如图片），嵌入静态资源的过程和传入附件类似，唯一的区别在于需要标识资源的cid

package com.springboot.demo.controller;

import java.io.File;

import javax.mail.internet.MimeMessage;

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.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;

@RestController @RequestMapping(“/email”) public class EmailController {

@Autowired
private JavaMailSender jms;
@Value("${spring.mail.username}")
private String from;
@RequestMapping("sendInlineMail")
public String sendInlineMail() {
    MimeMessage message = null;
    try {
        message = jms.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message, true);
        helper.setFrom(from);
        helper.setTo("888888@qq.com"); // 接收地址
        helper.setSubject("一封带静态资源的邮件"); // 标题
        helper.setText("<html><body>博客图：<img src='cid:img'/></body></html>", true); // 内容
        // 传入附件
        FileSystemResource file = new FileSystemResource(new File("src/main/resources/static/img/sunshine.png"));
        helper.addInline("img", file);
        jms.send(message);
        return "发送成功";
    } catch (Exception e) {
        e.printStackTrace();
        return e.getMessage();
    }
}

}


> `helper.addInline("img", file);`方法中的img和图片标签里cid后的名称相对应。启动项目访问http://localhost/email/sendInlineMail，提示发送成功
## 6. 使用模板发送邮件
1. 在发送验证码等情况下可以创建一个邮件的模板，唯一的变量为验证码。这个例子中使用的模板解析引擎为Thymeleaf，所以首先引入Thymeleaf依赖:

org.springframework.boot spring-boot-starter-thymeleaf


2. 在template目录下创建一个emailTemplate.html模板

<!DOCTYPE html>

您好，您的验证码为{code}，请在两分钟内使用完成操作。


3. 发送模板邮件，本质上还是发送HTML邮件，只不过多了绑定变量的过程

package com.springboot.demo.controller;

import java.io.File;

import javax.mail.internet.MimeMessage;

@RestController @RequestMapping(“/email”) public class EmailController {

@Autowired
private JavaMailSender jms;
@Value("${spring.mail.username}")
private String from;
@Autowired
private TemplateEngine templateEngine;
@RequestMapping("sendTemplateEmail")
public String sendTemplateEmail(String code) {
    MimeMessage message = null;
    try {
        message = jms.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message, true);
        helper.setFrom(from); 
        helper.setTo("888888@qq.com"); // 接收地址
        helper.setSubject("邮件摸板测试"); // 标题
        // 处理邮件模板
        Context context = new Context();
        context.setVariable("code", code);
        String template = templateEngine.process("emailTemplate", context);
        helper.setText(template, true);
        jms.send(message);
        return "发送成功";
    } catch (Exception e) {
        e.printStackTrace();
        return e.getMessage();
    }
}

}

```

其中code对应模板里的${code}变量。启动项目，访问http://localhost/email/sendTemplateEmail?code=EOS9，页面提示发送成功

7. （!待整理）邮件系统

8. 其他

Spring Boot (十)：邮件服务
 SpringBoot 发送邮件和附件（实用版）
https://mrbird.cc/Spring-Boot-Email.html

Code Learning Note

12-SpringBoot整合JavaMail

Spring Boot 整合 JavaMail

1. 简述

2. 基础整合使用

2.1. 引入依赖

2.2. 邮件参数配置

配置邮箱

发送邮件相关参数

hello world ! 这是一封Html邮件!

发送邮件相关参数

7. （!待整理）邮件系统

8. 其他