SpringBoot 邮件服务集成配置全面解析

前言

本文以网易邮箱（及 163 邮箱）为例，展示如何为 SpringBoot 项目集成邮件服务，其他邮箱配置类似，可以自行查看 Spring Email 指南或是其他官方文档

授权码

首先我们需要获取授权码，用于后续配置，登录邮箱： https://mail.163.com/

点击顶端设置，之后选择 POP3/SMTP/IMAP 选项

POP3/SMTP 服务已开启 – 开启该服务，开启是需要验证手机号发送验证码。

验证完成会返回授权码，该授权码只显示一次，记得保存，否则需要重新发送验证码获取新的授权码

添加依赖

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

配置文件

Spring Boot 为 JavaMailSender 提供了自动配置以及启动器模块。

spring:mail:  default-encoding: UTF-8  host: smtp.163.com # 网站发送邮件邮箱服务 host    port: 465  username: xxx@163.com # 邮箱  password: ONSWXXXXXXXX # 授权码 protocol: smtp  properties:  mail:  smtp:  auth: 'true'  socketFactory:  class: com.rymcu.forest.util.MailSSLSocketFactory  
#            class: javax.net.ssl.SSLSocketFactory  port: 465  ssl:  enable: true  starttls:  enable: true  stattls:  required: true  connectiontimeout: 5000  timeout: 3000  writetimeout: 5000

注意：上面的 password 不是你的邮箱密码，而是我们上一章节得到的授权码

编写代码

注：代码部分来自仓库：rymcu/forest: forest(森林)，同时进行了改动

SSL 相关配置

本章节为需要使用 https 协议的相关配置，没有该需求这个小章节可以先跳过，给后面配置完后再来配置也没有影响，不过应该需要设置 spring.mail.properties.mail.smtp.ssl.enable=false 以此来关闭 ssl

MailSSLSocketFactory

package com.rymcu.forest.util;import javax.net.SocketFactory;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.TrustManager;
import java.io.IOException;
import java.net.InetAddress;
import java.net.Socket;public class MailSSLSocketFactory extends SSLSocketFactory {private SSLSocketFactory factory;public MailSSLSocketFactory() {try {SSLContext sslcontext = SSLContext.getInstance("TLS");sslcontext.init(null, new TrustManager[]{new MailTrustManager()}, null);factory = sslcontext.getSocketFactory();} catch (Exception ex) {// ignore}}public static SocketFactory getDefault() {return new MailSSLSocketFactory();}@Overridepublic Socket createSocket() throws IOException {return factory.createSocket();}@Overridepublic Socket createSocket(Socket socket, String s, int i, boolean flag) throws IOException {return factory.createSocket(socket, s, i, flag);}@Overridepublic Socket createSocket(InetAddress inaddr, int i, InetAddress inaddr1, int j) throws IOException {return factory.createSocket(inaddr, i, inaddr1, j);}@Overridepublic Socket createSocket(InetAddress inaddr, int i) throws IOException {return factory.createSocket(inaddr, i);}@Overridepublic Socket createSocket(String s, int i, InetAddress inaddr, int j) throws IOException {return factory.createSocket(s, i, inaddr, j);}@Overridepublic Socket createSocket(String s, int i) throws IOException {return factory.createSocket(s, i);}@Overridepublic String[] getDefaultCipherSuites() {return factory.getDefaultCipherSuites();}@Overridepublic String[] getSupportedCipherSuites() {return factory.getSupportedCipherSuites();}
}

MailTrustManager

package com.rymcu.forest.util;import javax.net.ssl.X509TrustManager;
import java.security.cert.X509Certificate;public class MailTrustManager implements X509TrustManager {public void checkClientTrusted(X509Certificate[] cert, String authType) {// everything is trusted}public void checkServerTrusted(X509Certificate[] cert, String authType) {// everything is trusted}public X509Certificate[] getAcceptedIssuers() {return new X509Certificate[0];}
}

发送邮件

JavaMailService 定义邮件相关接口

public interface JavaMailService {/*** 发送验证码邮件** @param email 收件人邮箱* @return 执行结果 0：失败1：成功* @throws MessagingException*/Integer sendEmailCode(String email) throws MessagingException;/*** 发送找回密码邮件** @param email 收件人邮箱* @return 执行结果 0：失败1：成功* @throws MessagingException*/Integer sendForgetPasswordEmail(String email) throws MessagingException;/*** 发送下消息通知** @param notification* @return* @throws MessagingException*/Integer sendNotification(NotificationDTO notification) throws MessagingException;
}

JavaMailServiceImpl 邮件接口实现

@Service
public class JavaMailServiceImpl implements JavaMailService {/*** Java邮件发送器*/@Resourceprivate JavaMailSenderImpl mailSender;@Resourceprivate RedisService redisService;@Resourceprivate UserService userService;/*** thymeleaf模板引擎*/@Resourceprivate TemplateEngine templateEngine;@Value("${spring.mail.host}")private String SERVER_HOST;@Value("${spring.mail.port}")private String SERVER_PORT;@Value("${spring.mail.username}")private String USERNAME;@Value("${spring.mail.password}")private String PASSWORD;@Value("${resource.domain}")private String BASE_URL;@Overridepublic Integer sendEmailCode(String email) throws MessagingException {return sendCode(email, 0);}@Overridepublic Integer sendForgetPasswordEmail(String email) throws MessagingException {return sendCode(email, 1);}@Overridepublic Integer sendNotification(NotificationDTO notification) throws MessagingException {User user = userService.findById(String.valueOf(notification.getIdUser()));if (NotificationConstant.Comment.equals(notification.getDataType())) {String url = notification.getDataUrl();String thymeleafTemplatePath = "mail/commentNotification";Map<String, Object> thymeleafTemplateVariable = new HashMap<String, Object>(4);thymeleafTemplateVariable.put("user", notification.getAuthor().getUserNickname());thymeleafTemplateVariable.put("articleTitle", notification.getDataTitle());thymeleafTemplateVariable.put("content", notification.getDataSummary());thymeleafTemplateVariable.put("url", url);sendTemplateEmail(USERNAME,new String[]{user.getEmail()},new String[]{},"【RYMCU】 消息通知",thymeleafTemplatePath,thymeleafTemplateVariable);return 1;}return 0;}private Integer sendCode(String to, Integer type) throws MessagingException {SimpleMailMessage simpleMailMessage = new SimpleMailMessage();simpleMailMessage.setFrom(USERNAME);simpleMailMessage.setTo(to);if (type == 0) {Integer code = Utils.genCode();redisService.set(to, code, 5 * 60);simpleMailMessage.setSubject("新用户注册邮箱验证");simpleMailMessage.setText("【RYMCU】您的校验码是 " + code + ",有效时间 5 分钟，请不要泄露验证码给其他人。如非本人操作,请忽略！");mailSender.send(simpleMailMessage);return 1;} else if (type == 1) {String code = Utils.entryptPassword(to);String url = BASE_URL + "/forget-password?code=" + code;redisService.set(code, to, 15 * 60);String thymeleafTemplatePath = "mail/forgetPasswordTemplate";Map<String, Object> thymeleafTemplateVariable = new HashMap<String, Object>(1);thymeleafTemplateVariable.put("url", url);sendTemplateEmail(USERNAME,new String[]{to},new String[]{},"【RYMCU】 找回密码",thymeleafTemplatePath,thymeleafTemplateVariable);return 1;}return 0;}/*** 发送thymeleaf模板邮件** @param deliver                   发送人邮箱名 如： returntmp@163.com* @param receivers                 收件人，可多个收件人 如：11111@qq.com,2222@163.com* @param carbonCopys               抄送人，可多个抄送人 如：33333@sohu.com* @param subject                   邮件主题 如：您收到一封高大上的邮件，请查收。* @param thymeleafTemplatePath     邮件模板 如：mail\mailTemplate.html。* @param thymeleafTemplateVariable 邮件模板变量集*/public void sendTemplateEmail(String deliver, String[] receivers, String[] carbonCopys, String subject, String thymeleafTemplatePath,Map<String, Object> thymeleafTemplateVariable) throws MessagingException {String text = null;if (thymeleafTemplateVariable != null && thymeleafTemplateVariable.size() > 0) {Context context = new Context();thymeleafTemplateVariable.forEach((key, value) -> context.setVariable(key, value));text = templateEngine.process(thymeleafTemplatePath, context);}sendMimeMail(deliver, receivers, carbonCopys, subject, text, true, null);}/*** 发送的邮件(支持带附件/html类型的邮件)** @param deliver             发送人邮箱名 如： returntmp@163.com* @param receivers           收件人，可多个收件人 如：11111@qq.com,2222@163.com* @param carbonCopys         抄送人，可多个抄送人 如：3333@sohu.com* @param subject             邮件主题 如：您收到一封高大上的邮件，请查收。* @param text                邮件内容 如：测试邮件逗你玩的。 <html><body><img*                            src=\"cid:attchmentFileName\"></body></html>* @param attachmentFilePaths 附件文件路径 如：*                            需要注意的是addInline函数中资源名称attchmentFileName需要与正文中cid:attchmentFileName对应起来* @throws Exception 邮件发送过程中的异常信息*/private void sendMimeMail(String deliver, String[] receivers, String[] carbonCopys, String subject, String text,boolean isHtml, String[] attachmentFilePaths) throws MessagingException {StopWatch stopWatch = new StopWatch();stopWatch.start();MimeMessage mimeMessage = mailSender.createMimeMessage();MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);helper.setFrom(deliver);helper.setTo(receivers);helper.setCc(carbonCopys);helper.setSubject(subject);helper.setText(text, isHtml);// 添加邮件附件if (attachmentFilePaths != null && attachmentFilePaths.length > 0) {for (String attachmentFilePath : attachmentFilePaths) {File file = new File(attachmentFilePath);if (file.exists()) {String attachmentFile = attachmentFilePath.substring(attachmentFilePath.lastIndexOf(File.separator));long size = file.length();if (size > 1024 * 1024) {String msg = String.format("邮件单个附件大小不允许超过1MB，[%s]文件大小[%s]。", attachmentFilePath,file.length());throw new RuntimeException(msg);} else {FileSystemResource fileSystemResource = new FileSystemResource(file);helper.addInline(attachmentFile, fileSystemResource);}}}}mailSender.send(mimeMessage);stopWatch.stop();}}

JavaMailServiceTest 单元测试

/*** javaMail测试*/
class JavaMailServiceTest extends BaseServiceTest {private static final String REALITY_EMAIL = "xxxx@qq.com";@Autowiredprivate JavaMailService javaMailService;@Testvoid sendEmailCode() throws MessagingException {assertEquals(1, javaMailService.sendEmailCode(REALITY_EMAIL));}@Testvoid sendForgetPasswordEmail() throws MessagingException {assertEquals(1, javaMailService.sendForgetPasswordEmail(REALITY_EMAIL));}@Testvoid sendNotification() throws MessagingException {assertEquals(0, javaMailService.sendNotification(new NotificationDTO()));}
}