Spring Boot发送邮件详解

时间:2021-08-06 15:40:48

Spring框架使用JavaMailSender接口为发送邮件提供了一个简单的抽象,并且Spring Boot也为它提供了自动配置和一个starter模块。

如果spring.mail.host和相关的库(通过spring-boot-starter-mail定义)都存在,一个默认的JavaMailSender将被创建。该sender可以通过spring.mail命名空间下的配置项进一步自定义,下面本站素文宅博客具体讲述一下Spring Boot如何实现发送邮件。

引入spring-boot-starter-mail依赖,在pom.xml配置文件中增加如下内容(基于之前章节“Spring Boot 构建框架”中的pom.xml文件):

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

应用发送邮件案例

application.properties配置文件中加入如下配置(注意替换自己的用户名和密码):

?
1
2
3
4
5
6
spring.mail.host=smtp.qq.com
spring.mail.username=用户名 //发送方的邮箱
spring.mail.password=密码 //对于qq邮箱而言 密码指的就是发送方的授权码
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true

邮件service服务代码,具体如下:

?
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
@Service
public class MailService {
 private final Logger logger = LoggerFactory.getLogger(this.getClass());
  
 @Autowired
 private JavaMailSender sender;
  
 @Value("${spring.mail.username}")
 private String from;
  
 /**
  * 发送纯文本的简单邮件
  * @param to
  * @param subject
  * @param content
  */
 public void sendSimpleMail(String to, String subject, String content){
  SimpleMailMessage message = new SimpleMailMessage();
  message.setFrom(from);
  message.setTo(to);
  message.setSubject(subject);
  message.setText(content);
 
  try {
   sender.send(message);
   logger.info("简单邮件已经发送。");
  } catch (Exception e) {
   logger.error("发送简单邮件时发生异常!", e);
  }
 }
  
 /**
  * 发送html格式的邮件
  * @param to
  * @param subject
  * @param content
  */
 public void sendHtmlMail(String to, String subject, String content){
  MimeMessage message = sender.createMimeMessage();
 
  try {
   //true表示需要创建一个multipart message
   MimeMessageHelper helper = new MimeMessageHelper(message, true);
   helper.setFrom(from);
   helper.setTo(to);
   helper.setSubject(subject);
   helper.setText(content, true);
 
   sender.send(message);
   logger.info("html邮件已经发送。");
  } catch (MessagingException e) {
   logger.error("发送html邮件时发生异常!", e);
  }
 }
  
 /**
  * 发送带附件的邮件
  * @param to
  * @param subject
  * @param content
  * @param filePath
  */
 public void sendAttachmentsMail(String to, String subject, String content, String filePath){
  MimeMessage message = sender.createMimeMessage();
 
  try {
   //true表示需要创建一个multipart message
   MimeMessageHelper helper = new MimeMessageHelper(message, true);
   helper.setFrom(from);
   helper.setTo(to);
   helper.setSubject(subject);
   helper.setText(content, true);
 
   FileSystemResource file = new FileSystemResource(new File(filePath));
   String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
   helper.addAttachment(fileName, file);
    
   sender.send(message);
   logger.info("带附件的邮件已经发送。");
  } catch (MessagingException e) {
   logger.error("发送带附件的邮件时发生异常!", e);
  }
 }
  
 /**
  * 发送嵌入静态资源(一般是图片)的邮件
  * @param to
  * @param subject
  * @param content 邮件内容,需要包括一个静态资源的id,比如:<img src=\"cid:rscId01\" >
  * @param rscPath 静态资源路径和文件名
  * @param rscId 静态资源id
  */
 public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId){
  MimeMessage message = sender.createMimeMessage();
 
  try {
   //true表示需要创建一个multipart message
   MimeMessageHelper helper = new MimeMessageHelper(message, true);
   helper.setFrom(from);
   helper.setTo(to);
   helper.setSubject(subject);
   helper.setText(content, true);
 
   FileSystemResource res = new FileSystemResource(new File(rscPath));
   helper.addInline(rscId, res);
    
   sender.send(message);
   logger.info("嵌入静态资源的邮件已经发送。");
  } catch (MessagingException e) {
   logger.error("发送嵌入静态资源的邮件时发生异常!", e);
  }
 }
}

简单测试代码如下:

?
1
2
3
4
5
6
7
8
9
10
11
12
public class MailTests extends BasicUtClass{
 @Autowired
 private MailService mailService;
  
 private String to = "xujijun@mail.cn";
  
 @Test
 public void sendSimpleMail() {
  mailService.sendSimpleMail(to, "主题:简单邮件", "测试邮件内容");
 }
 
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。

原文链接:https://blog.yoodb.com/yoodb/article/detail/1427