SpringBoot整合email

写在前面

好久没写博客了orz.

最近负责一个科协平台的项目,由于没有经费,用爱发电,所以一切消息通知都使用邮件发送.

避坑

一开始打算使用学校的SMTP来实现,在本地已经跑通,所以就部署到了服务器上了.但是前端反应接收不到,后端log显示发送超时.

一阵排除之后才发现阿里云禁用了所有服务器的25号端口,所以只能使用其他接口,奈何学校只有25端口提供SMTP服务,因此只能改用大公司的邮箱服务.

SpringBoot整合Email

SpringBoot已经为我们整合好了Email相关包,所以我们只要导入就可了.

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-startermail</artifactId>
</dependency>

然后我们需要在配置文件中配置一些基本信息,以下是开启SSL加密的SMTP服务

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
#邮箱配置
mail:
username: 邮箱
password: SMTP密码,有些邮箱有专用密码
protocol: smtp
host: 邮箱对应的SMTP服务器
properties:
from: 邮箱
mail:
smtp:
ssl:
enable: true
auth: true
starttls:
enable: true
required: true
port: 端口号

不需要SSL的

1
2
3
4
5
6
7
8
9
#邮箱配置
mail:
username: 邮箱
password: SMTP密码,有些邮箱有专用密码
protocol: smtp
host: 邮箱对应的SMTP服务器
properties:
from: 邮箱
port: 端口号

配置写一个发送邮件类就可了

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
@Service
public class EmailService {
private Logger logger = LoggerFactory.getLogger(getClass());//提供日志类

@Autowired
private JavaMailSenderImpl mailSender;//注入邮件工具类


/**
* 发送邮件
*/
@Async
public MailVo sendMail(MailVo mailVo) {
try {
checkMail(mailVo); //1.检测邮件
sendMimeMail(mailVo); //2.发送邮件
return saveMail(mailVo); //3.保存邮件
} catch (Exception e) {
logger.error("发送邮件失败:", e);//打印错误信息
mailVo.setStatus("0");
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.getSentDate() == null) {//发送时间
mailVo.setSentDate(new Date());
messageHelper.setSentDate(mailVo.getSentDate());
}
mailSender.send(messageHelper.getMimeMessage());//正式发送邮件
mailVo.setStatus("1");
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");
}
}

邮件存储类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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;//报错信息

public String getId() {
return id;
}

public void setId(String id) {
this.id = id;
}

public String getFrom() {
return from;
}

public void setFrom(String from) {
this.from = from;
}

public String getTo() {
return to;
}

public void setTo(String to) {
this.to = to;
}

public String getSubject() {
return subject;
}

public void setSubject(String subject) {
this.subject = subject;
}

public String getText() {
return text;
}

public void setText(String text) {
this.text = text;
}

public Date getSentDate() {
return sentDate;
}

public void setSentDate(Date sentDate) {
this.sentDate = sentDate;
}

public String getCc() {
return cc;
}

public void setCc(String cc) {
this.cc = cc;
}

public String getBcc() {
return bcc;
}

public void setBcc(String bcc) {
this.bcc = bcc;
}

public String getStatus() {
return status;
}

public void setStatus(String status) {
this.status = status;
}

public String getError() {
return error;
}

public void setError(String error) {
this.error = error;
}
}