SpringBoot集成邮件服务竟如此简单,快速掌握邮件业务类的核心逻辑和企业邮件的日常服务。
什么是SMTP?
SMTP全称为SimpleMailTransferProtocol(简单邮件传输协议),它是一组用于从源地址到目的地址传输邮件的规范,通过它来控制邮件的中转方式。SMTP认证要求必须提供账号和密码才能登陆服务器,其设计目的在于避免用户受到垃圾邮件的侵扰。
什么是IMAP?
IMAP全称为InternetMessageAccessProtocol(互联网邮件访问协议),IMAP允许从邮件服务器上获取邮件的信息、下载邮件等。IMAP与POP类似,都是一种邮件获取协议。
什么是POP3?
POP3全称为PostOfficeProtocol3(邮局协议),POP3支持客户端远程管理服务器端的邮件。POP3常用于“离线”邮件处理,即允许客户端下载服务器邮件,然后服务器上的邮件将会被删除。目前很多POP3的邮件服务器只提供下载邮件功能,服务器本身并不删除邮件,这种属于改进版的POP3协议。
IMAP和POP3协议有什么不同呢?
两者最大的区别在于,IMAP允许双向通信,即在客户端的操作会反馈到服务器上,例如在客户端收取邮件、标记已读等操作,服务器会跟着同步这些操作。而对于POP协议虽然也允许客户端下载服务器邮件,但是在客户端的操作并不会同步到服务器上面的,例如在客户端收取或标记已读邮件,服务器不会同步这些操作。
什么是JavaMailSender和JavaMailSenderImpl?
JavaMailSender和JavaMailSenderImpl是Spring官方提供的集成邮件服务的接口和实现类,以简单高效的设计著称,目前是Java后端发送邮件和集成邮件服务的主流工具。
如何通过JavaMailSenderImpl发送邮件?
非常简单,直接在业务类注入JavaMailSenderImpl并调用send方法发送邮件。其中简单邮件可以通过SimpleMailMessage来发送邮件,而复杂的邮件(例如添加附件)可以借助MimeMessageHelper来构建MimeMessage发送邮件。例如:
@AutowiredprivateJavaMailSenderImplmailSender;publicvoidsendMail()throwsMessagingException{SimpleMailMessagesimpleMailMessage=newSimpleMailMessage();simpleMailMessage.setFrom("admin@163.com");simpleMailMessage.setTo("socks@qq.com");simpleMailMessage.setSubject("HappyNewYear");simpleMailMessage.setText("新年快乐!");mailSender.send(simpleMailMessage);MimeMessagemimeMessage=mailSender.createMimeMessage();MimeMessageHelpermessageHelper=newMimeMessageHelper(mimeMessage);messageHelper.setFrom("admin@163.com");messageHelper.setTo("socks@qq.com");messageHelper.setSubject("HappyNewYear");messageHelper.setText("新年快乐!");messageHelper.addInline("doge.gif",newFile("xx/xx/doge.gif"));messageHelper.addAttachment("work.docx",newFile("xx/xx/work.docx"));mailSender.send(mimeMessage);}为什么JavaMailSenderImpl能够开箱即用?
所谓开箱即用其实就是基于官方内置的自动配置,翻看源码可知晓邮件自动配置类(MailSenderPropertiesConfiguration)为上下文提供了邮件服务实例(JavaMailSenderImpl)。具体源码如下:
@Configuration@ConditionalOnProperty(prefix="spring.mail",name="host")classMailSenderPropertiesConfiguration{privatefinalMailPropertiesproperties;MailSenderPropertiesConfiguration(MailPropertiesproperties){this.properties=properties;}@Bean@ConditionalOnMissingBeanpublicJavaMailSenderImplmailSender(){JavaMailSenderImplsender=newJavaMailSenderImpl();applyProperties(sender);returnsender;}
其中MailProperties是关于邮件服务器的配置信息,具体源码如下:
@ConfigurationProperties(prefix="spring.mail")publicclassMailProperties{privatestaticfinalCharsetDEFAULT_CHARSET=StandardCharsets.UTF_8;privateStringhost;privateIntegerport;privateStringusername;privateStringpassword;privateStringprotocol="smtp";privateCharsetdefaultEncoding=DEFAULT_CHARSET;privateMap<String,String>properties=newHashMap<>();}
一、开启邮件服务
登陆网易邮箱163,在设置中打开并勾选POP3/SMTP/IMAP服务,然后会得到一个授权码,这个邮箱和授权码将用作登陆认证。
二、配置邮件服务首先咱们通过SpringInitializr创建工程
springboot-send-mail,如图所示:
然后在pom.xml引入web、thymeleaf和spring-boot-starter-mail等相关依赖。例如:
<dependencies><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-webartifactId>dependency><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-thymeleafartifactId>dependency><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-mailartifactId>dependency><dependency><groupId>org.webjarsgroupId><artifactId>webjars-locator-coreartifactId>dependency><dependency><groupId>org.webjarsgroupId><artifactId>jqueryartifactId><version>3.3.1version>dependency><dependency><groupId>org.webjarsgroupId><artifactId>bootstrapartifactId><version>3.3.7version>dependency><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-devtoolsartifactId><scope>runtimescope>dependency><dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starter-testartifactId><scope>testscope>dependency>dependencies>
根据前面提到的配置项(MailProperties)填写相关配置信息,其中spring.mail.username表示连接邮件服务器时认证的登陆账号,可以是普通的手机号或者登陆账号,并非一定是邮箱,为了解决这个问题,推荐大家在spring.mail.properties.from填写邮件发信人即真实邮箱。
然后在application.yml添加如下配置:
spring:mail:host:smtp.163.com#SMTP服务器地址username:socks#登陆账号password:123456#登陆密码(或授权码)properties:from:socks@163.com#邮件发信人(即真实邮箱)thymeleaf:cache:falseprefix:classpath:/views/servlet:multipart:max-file-size:10MB#限制单个文件大小max-request-size:50MB#限制请求总量
透过前面的进阶知识,我们知道在发送邮件前,需要先构建SimpleMailMessage或MimeMessage邮件信息类来填写邮件标题、邮件内容等信息,最后提交给JavaMailSenderImpl发送邮件,这样看起来没什么问题,也能实现既定目标,但在实际使用中会出现大量零散和重复的代码,还不便于保存邮件到数据库。
那么优雅的发送邮件应该是如何的呢?应该屏蔽掉这些构建信息和发送邮件的细节,不管是简单还是复杂邮件,都可以通过统一的API来发送邮件。例如:mailService.send(mailVo)。例如通过邮件信息类(MailVo)来保存发送邮件时的邮件主题、邮件内容等信息:
packagecom.hehe.vo;publicclassMailVo{privateStringid;privateStringfrom;privateStringto;privateStringsubject;privateStringtext;privateDatesentDate;privateStringcc;privateStringbcc;privateStringstatus;privateStringerror;@JsonIgnoreprivateMultipartFile[]multipartFiles;}
三、发送邮件和附件
除了发送邮件之外,还包括检测邮件和保存邮件等操作,例如:
- 检测邮件checkMail();首先校验邮件收信人、邮件主题和邮件内容这些必填项,若为空则拒绝发送。
- 发送邮件sendMimeMail();其次通过MimeMessageHelper来解析MailVo并构建MimeMessage传输邮件。
- 保存邮件sendMimeMail();最后将邮件保存到数据库,便于统计和追查邮件问题。
本案例邮件业务类MailService的具体源码如下:
packagecom.hehe.service;@ServicepublicclassMailService{privateLoggerlogger=LoggerFactory.getLogger(getClass());@AutowiredprivateJavaMailSenderImplmailSender;publicMailVosendMail(MailVomailVo){try{checkMail(mailVo);sendMimeMail(mailVo);returnsaveMail(mailVo);}catch(Exceptione){logger.error("发送邮件失败:",e);mailVo.setStatus("fail");mailVo.setError(e.getMessage());returnmailVo;}}privatevoidcheckMail(MailVomailVo){if(StringUtils.isEmpty(mailVo.getTo())){thrownewRuntimeException("邮件收信人不能为空");}if(StringUtils.isEmpty(mailVo.getSubject())){thrownewRuntimeException("邮件主题不能为空");}if(StringUtils.isEmpty(mailVo.getText())){thrownewRuntimeException("邮件内容不能为空");}}privatevoidsendMimeMail(MailVomailVo){try{MimeMessageHelpermessageHelper=newMimeMessageHelper(mailSender.createMimeMessage(),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(MultipartFilemultipartFile:mailVo.getMultipartFiles()){messageHelper.addAttachment(multipartFile.getOriginalFilename(),multipartFile);}}if(StringUtils.isEmpty(mailVo.getSentDate())){mailVo.setSentDate(newDate());messageHelper.setSentDate(mailVo.getSentDate());}mailSender.send(messageHelper.getMimeMessage());mailVo.setStatus("ok");logger.info("发送邮件成功:{}->{}",mailVo.getFrom(),mailVo.getTo());}catch(Exceptione){thrownewRuntimeException(e);}}privateMailVosaveMail(MailVomailVo){returnmailVo;}publicStringgetMailSendFrom(){returnmailSender.getJavaMailProperties().getProperty("from");}}
搞定了发送邮件最核心的业务逻辑,接下来咱们写一个简单页面用来发送邮件。
首先写好跟页面交互的控制器MailController,具体源码如下:
@RestControllerpublicclassMailController{@AutowiredprivateMailServicemailService;@GetMapping("/")publicModelAndViewindex(){ModelAndViewmv=newModelAndView("mail/sendMail");mv.addObject("from",mailService.getMailSendFrom());returnmv;}@PostMapping("/mail/send")publicMailVosendMail(MailVomailVo,MultipartFile[]files){mailVo.setMultipartFiles(files);returnmailService.sendMail(mailVo);}}
然后在/resources/views/mail目录新建sendMail.html,具体源码如下:
<htmlxmlns:th="http://www.thymeleaf.org"><head><metacharset="UTF-8"/><title>发送邮件title><linkth:href="@{/webjars/bootstrap/css/bootstrap.min.css}"rel="stylesheet"type="text/css"/><scriptth:src="@{/webjars/jquery/jquery.min.js}">script><scriptth:href="@{/webjars/bootstrap/js/bootstrap.min.js}">script>head><body><divclass="col-md-6"style="margin:20px;padding:20px;border:#E0E0E01pxsolid;"><marqueebehavior=" alternate"onfinish="alert(12)"id="mq"onMouseOut="this.start();$('#egg').text('嗯真听话!');"onMouseOver="this.stop();$('#egg').text('有本事放开我呀!');"><h5id="egg">祝大家新年快乐!h5><imgid="doge"src="http://pics.sc.chinaz.com/Files/pic/faces/3709/7.gif" alt="">marquee><formclass="form-horizontal"id="mailForm"><divclass="form-group"><labelclass="col-md-2control-label">邮件发信人:label><divclass="col-md-6"><inputclass="form-control"id="from"name="from"th:value="${from}"readonly="readonly">div>div><divclass="form-group"><labelclass="col-md-2control-label">邮件收信人:label><divclass="col-md-6"><inputclass="form-control"id="to"name="to"title="多个邮箱使用,隔开">div>div><divclass="form-group"><labelclass="col-md-2control-label">邮件主题:label><divclass="col-md-6"><inputclass="form-control"id="subject"name="subject">div>div><divclass="form-group"><labelclass="col-md-2control-label">邮件内容:label><divclass="col-md-6"><textareaclass="form-control"id="text"name="text"rows="5">textarea>div>div><divclass="form-group"><labelclass="col-md-2control-label">邮件附件:label><divclass="col-md-6"><inputclass="form-control"id="files"name="files"type="file"multiple="multiple">div>div><divclass="form-group"><labelclass="col-md-2control-label">邮件操作:label><divclass="col-md-3"><aclass="form-controlbtnbtn-primary"onclick="sendMail()">发送邮件a>div><divclass="col-md-3"><aclass="form-controlbtnbtn-default"onclick="clearForm()">清空a>div>div>form><scriptth:inline="javascript">varappCtx=[[${#request.getContextPath()}]];functionsendMail(){varformData=newFormData($('#mailForm')[0]);$.ajax({url:appCtx+'/mail/send',type:"POST",data:formData,contentType:false,processData:false,success:function(result){alert(result.status==='ok'?"发送成功!":"你被Doge嘲讽了:"+result.error);},error:function(){alert("发送失败!");}});}functionclearForm(){$('#mailForm')[0].reset();}setInterval(function(){vartotal=$('#mq'). width();var width=$('#doge'). width();varleft=$('#doge').offset().left;if(left<= width/2+20){$('#doge').css('transform','rotateY(180deg)')}if(left>=total- width/2-40){$('#doge').css('transform','rotateY(-360deg)')}});script>div>body>html>
四、测试发送邮件
如果是初学者,建议大家先下载源码,修改配置后运行工程,成功后再自己重新写一遍代码,这样有助于加深记忆。
启动工程并访问:http://localhost:8080然后可以看到发送邮件的主界面如下:
然后填写你的小号邮箱,点击发送邮件,若成功则可以登陆小号邮箱查看邮件和刚才上传的附件。
至此发送邮件代码全部完成,欢迎大家下载并关注Github源码。
五、常见失败编码
如果企业定制了邮件服务器,自然会记录邮件日志,根据错误编码存储日志有利于日常维护。例如这些由网易邮箱提供的错误编码标识:421421HL:REP该IP发送行为异常,存在接收者大量不存在情况,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并核对发送列表有效性;
421HL:ICC该IP同时并发连接数过大,超过了网易的限制,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并降低IP并发连接数量;
421HL:IFC该IP短期内发送了大量信件,超过了网易的限制,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并降低发送频率;
421HL:MEP该IP发送行为异常,存在大量伪造发送域域名行为,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并使用真实有效的域名发送;
450450MI:CEL发送方出现过多的错误指令。请检查发信程序;
450MI:DMC当前连接发送的邮件数量超出限制。请减少每次连接中投递的邮件数量;
450MI:CCL发送方发送超出正常的指令数量。请检查发信程序;
450RP:DRC当前连接发送的收件人数量超出限制。请控制每次连接投递的邮件数量;
450RP:CCL发送方发送超出正常的指令数量。请检查发信程序;
450DT:RBL发信IP位于一个或多个RBL里。请参考
http://www.rbls.org/关于RBL的相关信息;
450WM:BLI该IP不在网易允许的发送地址列表里;
450WM:BLU此用户不在网易允许的发信用户列表里;451451DT:SPM,pleasetryagain邮件正文带有垃圾邮件特征或发送环境缺乏规范性,被临时拒收。请保持邮件队列,两分钟后重投邮件。需调整邮件内容或优化发送环境;
451Requestedmailactionnottaken:toomuchfailauthentication登录失败次数过多,被临时禁止登录。请检查密码与帐号验证设置;
451RP:CEL发送方出现过多的错误指令。请检查发信程序;
451MI:DMC当前连接发送的邮件数量超出限制。请控制每次连接中投递的邮件数量;
451MI:SFQ发信人在15分钟内的发信数量超过限制,请控制发信频率;
451RP:QRC发信方短期内累计的收件人数量超过限制,该发件人被临时禁止发信。请降低该用户发信频率;
451Requestedactionaborted:localerrorinprocessing系统暂时出现故障,请稍后再次尝试发送;500500Error:badsyntaxU发送的smtp命令语法有误;
550MI:NHDHELO命令不允许为空;
550MI:IMF发信人电子邮件地址不合规范。请参考http://www.rfc-editor.org/关于电子邮件规范的定义;
550MI:SPF发信IP未被发送域的SPF许可。请参考http://www.openspf.org/关于SPF规范的定义;
550MI:DMA该邮件未被发信域的DMARC许可。请参考http://dmarc.org/关于DMARC规范的定义;
550MI:STC发件人当天的连接数量超出了限定数量,当天不再接受该发件人的邮件。请控制连接次数;
550RP:FRL网易邮箱不开放匿名转发(Openrelay);
550RP:RCL群发收件人数量超过了限额,请减少每封邮件的收件人数量;
550RP:TRC发件人当天内累计的收件人数量超过限制,当天不再接受该发件人的邮件。请降低该用户发信频率;
550DT:SPM邮件正文带有很多垃圾邮件特征或发送环境缺乏规范性。需调整邮件内容或优化发送环境;
550InvalidUser请求的用户不存在;
550Userinblacklist该用户不被允许给网易用户发信;
550Usersuspended请求的用户处于禁用或者冻结状态;
550Requestedmailactionnottaken:toomuchrecipient群发数量超过了限额;552552IllegalAttachment不允许发送该类型的附件,包括以.uu.pif.scr.mim.hqx.bhx.cmd.vbs.bat.com.vbe.vb.js.wsh等结尾的附件;
552Requestedmailactionaborted:exceededmailsizelimit发送的信件大小超过了网易邮箱允许接收的最大限制;553553Requestedactionnottaken:NULLsenderisnotallowed不允许发件人为空,请使用真实发件人发送;
553Requestedactionnottaken:LocaluseronlySMTP类型的机器只允许发信人是本站用户;
553Requestedactionnottaken:nosmtpMXonlyMX类型的机器不允许发信人是本站用户;
553authenticationisrequiredSMTP需要身份验证,请检查客户端设置;554554DT:SPM发送的邮件内容包含了未被许可的信息,或被系统识别为垃圾邮件。请检查是否有用户发送病毒或者垃圾邮件;
554DT:SUM信封发件人和信头发件人不匹配;
554IPisrejected,smtpautherrorlimitexceed该IP验证失败次数过多,被临时禁止连接。请检查验证信息设置;
554HL:IHU发信IP因发送垃圾邮件或存在异常的连接行为,被暂时挂起。请检测发信IP在历史上的发信情况和发信程序是否存在异常;
554HL:IPB该IP不在网易允许的发送地址列表里;
554MI:STC发件人当天内累计邮件数量超过限制,当天不再接受该发件人的投信。请降低发信频率;
554MI:SPB此用户不在网易允许的发信用户列表里;
554IPinblacklist该IP不在网易允许的发送地址列表里。