SpringBoot 发送邮件和附件
作者：yizhiwazi
链接：https://www.jianshu.com/p/5eb000544dd7SpringBoot集成邮件服务竟如此简单，还等什么，快来学习涨姿势吧！！
基础知识
-
什么是SMTP？
SMTP全称为Simple Mail Transfer Protocol（简单邮件传输协议），它是一组用于从源地址到目的地址传输邮件的规范，通过它来控制邮件的中转方式。SMTP认证要求必须提供账号和密码才能登陆服务器，其设计目的在于避免用户受到垃圾邮件的侵扰。 -
什么是IMAP？
IMAP全称为Internet Message Access Protocol（互联网邮件访问协议），IMAP允许从邮件服务器上获取邮件的信息、下载邮件等。IMAP与POP类似，都是一种邮件获取协议。 -
什么是POP3？
POP3全称为Post Office Protocol 3（邮局协议），POP3支持客户端远程管理服务器端的邮件。POP3常用于“离线”邮件处理，即允许客户端下载服务器邮件，然后服务器上的邮件将会被删除。目前很多POP3的邮件服务器只提供下载邮件功能，服务器本身并不删除邮件，这种属于改进版的POP3协议。 -
IMAP和POP3协议有什么不同呢？
两者最大的区别在于，IMAP允许双向通信，即在客户端的操作会反馈到服务器上，例如在客户端收取邮件、标记已读等操作，服务器会跟着同步这些操作。而对于POP协议虽然也允许客户端下载服务器邮件，但是在客户端的操作并不会同步到服务器上面的，例如在客户端收取或标记已读邮件，服务器不会同步这些操作。
进阶知识
-
什么是
JavaMailSender和JavaMailSenderImpl？JavaMailSender和JavaMailSenderImpl是Spring官方提供的集成邮件服务的接口和实现类，以简单高效的设计著称，目前是Java后端发送邮件和集成邮件服务的主流工具。 -
如何通过
JavaMailSenderImpl发送邮件？
非常简单，直接在业务类注入JavaMailSenderImpl并调用send方法发送邮件。其中简单邮件可以通过SimpleMailMessage来发送邮件，而复杂的邮件（例如添加附件）可以借助MimeMessageHelper来构建MimeMessage发送邮件。例如：
@Autowired
private JavaMailSenderImpl mailSender;
public void sendMail() throws MessagingException { //简单邮件
SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
simpleMailMessage.setFrom("[email protected]");
simpleMailMessage.setTo("[email protected]");
simpleMailMessage.setSubject("Happy New Year");
simpleMailMessage.setText("新年快乐！");
mailSender.send(simpleMailMessage); //复杂邮件
MimeMessage mimeMessage = mailSender.createMimeMessage();
MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage);
messageHelper.setFrom("[email protected]");
messageHelper.setTo("[email protected]");
messageHelper.setSubject("Happy New Year");
messageHelper.setText("新年快乐！");
messageHelper.addInline("doge.gif", new File("xx/xx/doge.gif"));
messageHelper.addAttachment("work.docx", new File("xx/xx/work.docx"));
mailSender.send(mimeMessage);
}-
为什么
JavaMailSenderImpl能够开箱即用 ？
所谓开箱即用其实就是基于官方内置的自动配置，翻看源码可知晓邮件自动配置类(MailSenderPropertiesConfiguration)为上下文提供了邮件服务实例(JavaMailSenderImpl)。具体源码如下：
@Configuration@ConditionalOnProperty(prefix = "spring.mail", name = "host")class MailSenderPropertiesConfiguration { private final MailProperties properties;
MailSenderPropertiesConfiguration(MailProperties properties) { this.properties = properties;
}
@Bean
@ConditionalOnMissingBean
public JavaMailSenderImpl mailSender() {
JavaMailSenderImpl sender = new JavaMailSenderImpl();
applyProperties(sender);
return sender;
}其中MailProperties是关于邮件服务器的配置信息，具体源码如下：
@ConfigurationProperties(prefix = "spring.mail")
public class MailProperties {
private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8; private String host; private Integer port; private String username; private String password; private String protocol = "smtp"; private Charset defaultEncoding = DEFAULT_CHARSET; private Map properties = new HashMap<>();
} 使用教程
一、开启邮件服务
登陆网易邮箱163，在设置中打开并勾选POP3/SMTP/IMAP服务，然后会得到一个授权码，这个邮箱和授权码将用作登陆认证。
二、配置邮件服务
首先咱们通过 Spring Initializr 创建工程springboot-send-mail，如图所示：
然后在pom.xml 引入web、thymeleaf 和spring-boot-starter-mail等相关依赖。例如：
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-thymeleaf
org.springframework.boot
spring-boot-starter-mail
org.webjars
webjars-locator-core
org.webjars
jquery
3.3.1
org.webjars
bootstrap
3.3.7
org.springframework.boot
spring-boot-devtools
runtime
org.springframework.boot
spring-boot-starter-test
test
根据前面提到的配置项
(MailProperties)填写相关配置信息，其中spring.mail.username表示连接邮件服务器时认证的登陆账号，可以是普通的手机号或者登陆账号，并非一定是邮箱，为了解决这个问题，推荐大家在spring.mail. properties.from填写邮件发信人即真实邮箱。
然后在application.yml添加如下配置：
spring:
mail:
host: smtp.163.com #SMTP服务器地址
username: socks #登陆账号
password: 123456 #登陆密码（或授权码）
properties:
from: [email protected] #邮件发信人（即真实邮箱）
thymeleaf:
cache: false
prefix: classpath:/views/ servlet:
multipart:
max-file-size: 10MB #限制单个文件大小
max-request-size: 50MB #限制请求总量
透过前面的进阶知识，我们知道在发送邮件前，需要先构建
SimpleMailMessage或MimeMessage邮件信息类来填写邮件标题、邮件内容等信息，最后提交给JavaMailSenderImpl发送邮件，这样看起来没什么问题，也能实现既定目标，但在实际使用中会出现大量零散和重复的代码，还不便于保存邮件到数据库。
那么优雅的发送邮件应该是如何的呢？应该屏蔽掉这些构建信息和发送邮件的细节，不管是简单还是复杂邮件，都可以通过统一的API来发送邮件。例如：
mailService.send(mailVo)。
例如通过邮件信息类(MailVo) 来保存发送邮件时的邮件主题、邮件内容等信息 ：
package com.hehe.vo;
public class MailVo {
private String id;//邮件id
private String from;//邮件发送人
private String to;//邮件接收人（多个邮箱则用逗号","隔开）
private String subject;//邮件主题
private String text;//邮件内容
private Date sentDate;//发送时间
private String cc;//抄送（多个邮箱则用逗号","隔开）
private String bcc;//密送（多个邮箱则用逗号","隔开）
private String status;//状态
private String error;//报错信息
@JsonIgnore
private File[] files;//邮件附件
//省略GET&SET方法}三、发送邮件和附件
=========== 接下来正式介绍发送邮件的最核心逻辑 前方高能 =============
除了发送邮件之外，还包括检测邮件和保存邮件等操作，例如：
-
检测邮件
checkMail();校验合法性：邮件收信人、邮件主题和邮件内容均为必填项，缺一不可。 -
发送邮件
sendMimeMail();首先通过MimeMessageHelper来解析MailVo和构建MimeMessage，r调用暗黑JavaMailSenderImpl快速发送邮件。 -
保存邮件
sendMimeMail();最后将邮件保存到数据库，便于统计和追查邮件问题。
本案例邮件业务类 MailService 的具体源码如下：
package com.hehe.service;
/**
* 邮件业务类 MailService
*/
@Service
public class MailService {
private Logger logger = LoggerFactory.getLogger(getClass());//提供日志类
@Autowired
private JavaMailSenderImpl mailSender;//注入邮件工具类
/**
* 发送邮件
*/
public MailVo sendMail(MailVo mailVo) {
try {
checkMail(mailVo); //1.检测邮件
sendMimeMail(mailVo); //2.发送邮件
return saveMail(mailVo); //3.保存邮件
} catch (Exception e) {
logger.error("发送邮件失败:", e);//打印错误信息
mailVo.setStatus("fail");
mailVo.setError(e.getMessage());
return mailVo;
}
} //检测邮件信息类
private void checkMail(MailVo mailVo) {
if (StringUtils.isEmpty(mailVo.getTo())) {
throw new RuntimeException("邮件收信人不能为空");
}
if (StringUtils.isEmpty(mailVo.getSubject())) { throw new RuntimeException("邮件主题不能为空");
}
if (StringUtils.isEmpty(mailVo.getText())) { throw new RuntimeException("邮件内容不能为空");
}
} //构建复杂邮件信息类
private void sendMimeMail(MailVo mailVo) {
try {
MimeMessageHelper messageHelper = new MimeMessageHelper(mailSender.createMimeMessage(), true);//true表示支持复杂类型
mailVo.setFrom(getMailSendFrom());//邮件发信人从配置项读取
messageHelper.setFrom(mailVo.getFrom());//邮件发信人
messageHelper.setTo(mailVo.getTo().split(","));//邮件收信人
messageHelper.setSubject(mailVo.getSubject());//邮件主题
messageHelper.setText(mailVo.getText());//邮件内容
if (!StringUtils.isEmpty(mailVo.getCc())) {//抄送
messageHelper.setCc(mailVo.getCc().split(","));
} if (!StringUtils.isEmpty(mailVo.getBcc())) {//密送
messageHelper.setCc(mailVo.getBcc().split(","));
} if (mailVo.getMultipartFiles() != null) {//添加邮件附件
for (MultipartFile multipartFile : mailVo.getMultipartFiles()) {
messageHelper.addAttachment(multipartFile.getOriginalFilename(), multipartFile);
}
} if (StringUtils.isEmpty(mailVo.getSentDate())) {//发送时间
mailVo.setSentDate(new Date());
messageHelper.setSentDate(mailVo.getSentDate());
}
mailSender.send(messageHelper.getMimeMessage());//正式发送邮件
mailVo.setStatus("ok");
logger.info("发送邮件成功：{}->{}",
mailVo.getFrom(),
mailVo.getTo());
} catch (Exception e) {
throw new RuntimeException(e);//发送失败
}
} //保存邮件
private MailVo saveMail(MailVo mailVo) { //将邮件保存到数据库..
return mailVo;
} //获取邮件发信人
public String getMailSendFrom() {
return mailSender.getJavaMailProperties().getProperty("from");
}
}
搞定了发送邮件最核心的业务逻辑，接下来咱们写一个简单页面用来发送邮件。
首先写好跟页面交互的控制器 MailController，具体源码如下：
@RestController
public class MailController {
@Autowired
private MailService mailService;
/**
* 发送邮件的主界面
*/
@GetMapping("/")
public ModelAndView index() {
ModelAndView mv = new ModelAndView("mail/sendMail");//打开发送邮件的页面
mv.addObject("from", mailService.getMailSendFrom());//邮件发信人
return mv;
}
/**
* 发送邮件
*/
@PostMapping("/mail/send")
public MailVo sendMail(MailVo mailVo, MultipartFile[] files) {
mailVo.setMultipartFiles(files);
return mailService.sendMail(mailVo);//发送邮件和附件
}
}
然后在/resources/views/mail目录新建sendMail.html，具体源码如下：
发送邮件
祝大家新年快乐！
邮件发信人: