在日常工作开发中,项目中会使用到发送邮件功能,通过邮件实时通知,实现告警或预警功能,首先介绍以下与发送接受邮件相关的一些协议:
JavaMailSender和JavaMailSenderImpl 是Spring官方提供的集成邮件服务的接口和实现类,以简单高效的设计著称,目前是Java后端发送邮件和集成邮件服务的主流工具。
非常简单,直接在业务类注入JavaMailSenderImpl并调用send方法发送邮件。其中简单邮件可以通过SimpleMailMessage来发送邮件,而复杂的邮件(例如添加附件)可以借助MimeMessageHelper来构建MimeMessage发送邮件
SMTP全称为Simple Mail Transfer Protocol(简单邮件传输协议),它是一组用于从源地址到目的地址传输邮件的规范,通过它来控制邮件的中转方式。SMTP认证要求必须提供账号和密码才能登陆服务器,其设计目的在于避免用户受到垃圾邮件的侵扰。
IMAP全称为Internet Message Access Protocol(互联网邮件访问协议),IMAP允许从邮件服务器上获取邮件的信息、下载邮件等。IMAP与POP类似,都是一种邮件获取协议。
POP3全称为Post Office Protocol 3(邮局协议),POP3支持客户端远程管理服务器端的邮件。POP3常用于“离线”邮件处理,即允许客户端下载服务器邮件,然后服务器上的邮件将会被删除。目前很多POP3的邮件服务器只提供下载邮件功能,服务器本身并不删除邮件,这种属于改进版的POP3协议。
两者最大的区别在于,IMAP允许双向通信,即在客户端的操作会反馈到服务器上,例如在客户端收取邮件、标记已读等操作,服务器会跟着同步这些操作。而对于POP协议虽然也允许客户端下载服务器邮件,但是在客户端的操作并不会同步到服务器上面的,例如在客户端收取或标记已读邮件,服务器不会同步这些操作。
申请授权码,以QQ邮箱为例:登录QQ邮箱,点击顶部设置,打开账号面板,下拉,开启SMTP服务,点击生成授权码。
org.springframework.boot
spring-boot-starter-mail
org.springframework.boot
spring-boot-devtools
true
org.projectlombok
lombok
true
注意:这里以QQ邮箱为例,如果为网易 163 邮箱,对应的SMTP服务器地址为smtp.163.com
##邮件发送服务
#SMTP服务器地址
spring.mail.host=smtp.qq.com
#登陆账号
spring.mail.username=31**[email protected]
#或授权码
spring.mail.password=rbjfrpavuoiec
#邮件发信人(即真实邮箱)
spring.mail.properties.from=31**[email protected]
import java.util.Date;
import org.springframework.web.multipart.MultipartFile;
import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.Data;
/**
*
* 类名称:MailVo
* 类描述: 保存发送邮件时的邮件主题、邮件内容等信息
* 创建人:Administrator
* 创建时间:2020年4月8日 下午2:53:28
* 修改人:Administrator
* 修改时间:2020年4月8日 下午2:53:28
* 修改备注:
* @version
*/
@Data
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;//报错信息
private String filePath;//资源路径
private String rscId;//资源id (可能有多个图片)
private String rscPath;
@JsonIgnore
private MultipartFile[] multipartFiles;//邮件附件
}
import com.ykx.mail.model.MailVo;
public interface MailService {
/**
* 发送纯文本邮件
* @param toAddr 发送给谁
* @param title 标题
* @param content 内容
*/
public void sendTextMail(MailVo vo);
/**
* 发送 html 邮件
* @param toAddr
* @param title
* @param content 内容(HTML)
*/
public void sendHtmlMail(MailVo vo);
/**
* 发送待附件的邮件
* @param toAddr
* @param title
* @param content
* @param filePath 附件地址
*/
public void sendAttachmentsMail(MailVo vo);
/**
* 发送文本中有静态资源(图片)的邮件
* @param toAddr
* @param title
* @param content
* @param rscPath 资源路径
* @param rscId 资源id (可能有多个图片)
*/
public void sendInlineResourceMail(MailVo vo);
}
import java.io.File;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
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.JavaMailSenderImpl;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Component;
import com.ykx.mail.model.MailVo;
import com.ykx.mail.service.MailService;
@Component
public class MailServiceImpl implements MailService {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
private JavaMailSender mailSender;
@Autowired
private JavaMailSenderImpl mailSenderImp;//注入邮件工具类
// 注入常量用户名
@Value("${spring.mail.username}")
private String from;
/**
* 发送文本邮件
*/
@Override
public void sendTextMail(MailVo vo) {
// 纯文本邮件对象
SimpleMailMessage message = new SimpleMailMessage();
message.setFrom(from);
message.setTo(vo.getTo().split(","));
message.setSubject(vo.getSubject());
message.setText(vo.getText());
try {
mailSender.send(message);
logger.info("Text邮件已经发送。");
} catch (Exception e) {
logger.error("发送Text邮件时发生异常!", e);
}
}
/**
* 发送html邮件
* @param toAddr
* @param title
* @param content
*/
@Override
public void sendHtmlMail(MailVo vo) {
// html 邮件对象
MimeMessage message = mailSender.createMimeMessage();
try {
//true表示需要创建一个multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(from);
helper.setTo(vo.getTo().split(","));
helper.setSubject(vo.getSubject());
helper.setText(vo.getText(), true);
mailSender.send(message);
logger.info("html邮件发送成功");
} catch (MessagingException e) {
logger.error("发送html邮件时发生异常!", e);
}
}
/**
* 发送带附件的邮件
* @param toAddr
* @param title
* @param content
* @param filePath
*/
public void sendAttachmentsMail(MailVo vo){
MimeMessage message = mailSender.createMimeMessage();
try {
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(from);
helper.setTo(vo.getTo().split(","));
helper.setSubject(vo.getSubject());
helper.setText(vo.getText(), true);
FileSystemResource file = new FileSystemResource(new File(vo.getFilePath()));
String fileName = vo.getFilePath().substring(vo.getFilePath().lastIndexOf(File.separator));
helper.addAttachment(fileName, file);
//helper.addAttachment("test"+fileName, file);
mailSender.send(message);
logger.info("带附件的邮件已经发送。");
} catch (MessagingException e) {
logger.error("发送带附件的邮件时发生异常!", e);
}
}
/**
* 发送正文中有静态资源(图片)的邮件
* @param toAddr
* @param title
* @param content
* @param rscPath
* @param rscId
*/
public void sendInlineResourceMail(MailVo vo){
MimeMessage message = mailSender.createMimeMessage();
try {
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(from);
helper.setTo(vo.getTo().split(","));
helper.setSubject(vo.getSubject());
helper.setText(vo.getText(), true);
FileSystemResource res = new FileSystemResource(new File(vo.getRscPath()));
helper.addInline(vo.getRscId(), res);
mailSender.send(message);
logger.info("嵌入静态资源的邮件已经发送。");
} catch (MessagingException e) {
logger.error("发送嵌入静态资源的邮件时发生异常!", e);
}
}
//获取邮件发信人
public String getMailSendFrom() {
return mailSenderImp.getJavaMailProperties().getProperty("from");
}
}
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import com.ykx.mail.model.MailVo;
import com.ykx.mail.service.MailService;
@RestController
public class MailController {
@Autowired
private MailService mailService;
/**
* 发送纯文本邮件
*/
@PostMapping("/send/txt")
public void sendTextMail(@RequestBody MailVo vo) {
mailService.sendTextMail(vo);
}
/**
* 发送 html 邮件
*/
@PostMapping("/send/html")
public void sendHtmlMail(@RequestBody MailVo vo){
mailService.sendHtmlMail(vo);
}
/**
* 发送待附件的邮件
*/
@PostMapping("/send/attach")
public void sendAttachmentsMail(@RequestBody MailVo vo){
mailService.sendAttachmentsMail(vo);
}
/**
* 发送文本中有静态资源(图片)的邮件
*/
@PostMapping("/send/line")
public void sendInlineResourceMail(@RequestBody MailVo vo){
mailService.sendInlineResourceMail(vo);
}
}
如果企业定制了邮件服务器,自然会记录邮件日志,根据错误编码存储日志有利于日常维护。
例如这些由网易邮箱提供的错误编码标识:
421
421 HL:REP 该IP发送行为异常,存在接收者大量不存在情况,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并核对发送列表有效性;
421 HL:ICC 该IP同时并发连接数过大,超过了网易的限制,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并降低IP并发连接数量;
421 HL:IFC 该IP短期内发送了大量信件,超过了网易的限制,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并降低发送频率;
421 HL:MEP 该IP发送行为异常,存在大量伪造发送域域名行为,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并使用真实有效的域名发送;
450
450 MI:CEL 发送方出现过多的错误指令。请检查发信程序;
450 MI:DMC 当前连接发送的邮件数量超出限制。请减少每次连接中投递的邮件数量;
450 MI:CCL 发送方发送超出正常的指令数量。请检查发信程序;
450 RP:DRC 当前连接发送的收件人数量超出限制。请控制每次连接投递的邮件数量;
450 RP:CCL 发送方发送超出正常的指令数量。请检查发信程序;
450 DT:RBL 发信IP位于一个或多个RBL里。请参考http://www.rbls.org/关于RBL的相关信息;
450 WM:BLI 该IP不在网易允许的发送地址列表里;
450 WM:BLU 此用户不在网易允许的发信用户列表里;
451
451 DT:SPM ,please try again 邮件正文带有垃圾邮件特征或发送环境缺乏规范性,被临时拒收。请保持邮件队列,两分钟后重投邮件。需调整邮件内容或优化发送环境;
451 Requested mail action not taken: too much fail authentication 登录失败次数过多,被临时禁止登录。请检查密码与帐号验证设置;
451 RP:CEL 发送方出现过多的错误指令。请检查发信程序;
451 MI:DMC 当前连接发送的邮件数量超出限制。请控制每次连接中投递的邮件数量;
451 MI:SFQ 发信人在15分钟内的发信数量超过限制,请控制发信频率;
451 RP:QRC 发信方短期内累计的收件人数量超过限制,该发件人被临时禁止发信。请降低该用户发信频率;
•451 Requested action aborted: local error in processing 系统暂时出现故障,请稍后再次尝试发送;
500
500 Error: bad syntaxU 发送的smtp命令语法有误;
550 MI:NHD HELO命令不允许为空;
550 MI:IMF 发信人电子邮件地址不合规范。请参考http://www.rfc-editor.org/关于电子邮件规范的定义;
550 MI:SPF 发信IP未被发送域的SPF许可。请参考http://www.openspf.org/关于SPF规范的定义;
550 MI:DMA 该邮件未被发信域的DMARC许可。请参考http://dmarc.org/关于DMARC规范的定义;
550 MI:STC 发件人当天的连接数量超出了限定数量,当天不再接受该发件人的邮件。请控制连接次数;
550 RP:FRL 网易邮箱不开放匿名转发(Open relay);
550 RP:RCL 群发收件人数量超过了限额,请减少每封邮件的收件人数量;
550 RP:TRC 发件人当天内累计的收件人数量超过限制,当天不再接受该发件人的邮件。请降低该用户发信频率;
550 DT:SPM 邮件正文带有很多垃圾邮件特征或发送环境缺乏规范性。需调整邮件内容或优化发送环境;
550 Invalid User 请求的用户不存在;
550 User in blacklist 该用户不被允许给网易用户发信;
550 User suspended 请求的用户处于禁用或者冻结状态;
550 Requested mail action not taken: too much recipient 群发数量超过了限额;
552
552 Illegal Attachment 不允许发送该类型的附件,包括以.uu .pif .scr .mim .hqx .bhx .cmd .vbs .bat .com .vbe .vb .js .wsh等结尾的附件;
552 Requested mail action aborted: exceeded mailsize limit 发送的信件大小超过了网易邮箱允许接收的最大限制;
-553
553 Requested action not taken: NULL sender is not allowed 不允许发件人为空,请使用真实发件人发送;
553 Requested action not taken: Local user only SMTP类型的机器只允许发信人是本站用户;
553 Requested action not taken: no smtp MX only MX类型的机器不允许发信人是本站用户;
553 authentication is required SMTP需要身份验证,请检查客户端设置;
-554
554 DT:SPM 发送的邮件内容包含了未被许可的信息,或被系统识别为垃圾邮件。请检查是否有用户发送病毒或者垃圾邮件;
554 DT:SUM 信封发件人和信头发件人不匹配;
554 IP is rejected, smtp auth error limit exceed 该IP验证失败次数过多,被临时禁止连接。请检查验证信息设置;
554 HL:IHU 发信IP因发送垃圾邮件或存在异常的连接行为,被暂时挂起。请检测发信IP在历史上的发信情况和发信程序是否存在异常;
554 HL:IPB 该IP不在网易允许的发送地址列表里;
554 MI:STC 发件人当天内累计邮件数量超过限制,当天不再接受该发件人的投信。请降低发信频率;
554 MI:SPB 此用户不在网易允许的发信用户列表里;
554 IP in blacklist 该IP不在网易允许的发送地址列表里。
附上项目文档结构:
参考文档:
作者:yizhiwazi
链接:https://www.jianshu.com/p/5eb000544dd7