SpringBoot(十三) JavaMailSender

相信使用过Spring的众多开发者都知道Spring提供了非常好用的JavaMailSender接口实现邮件发送。在Spring Boot的Starter模块中也为此提供了自动化配置。下面通过实例看看如何在Spring Boot中使用JavaMailSender发送邮件。

项目构建

pom.xml

在Spring Boot的工程 pom.xml 文件中添加 spring-boot-starter-mail 依赖

1
2
3
4
5
<!-- 引入spring-boot-starter-mail依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>

和其他自动化配置模块一样,添加依赖后,只需要在 application.yml 文件中配置相应的属性内容即可。

application.yml

下面以QQ邮箱为例,替换usernamepassword 即可
注意: qq邮箱应该使用独立密码,去qq邮箱设置里面获取

1
2
3
4
5
spring:
mail:
host: smtp.qq.com
username: username@qq.com
password: your-password

简单示例

简单邮件 - 测试类

模拟实现简单邮件的发送:

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
package com.ray.springboot213;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot213ApplicationTests {

// 获取JavaMailSender bean
@Autowired
private JavaMailSender javaMailSender;

// 获取配置文件的username
@Value("${spring.mail.username}")
private String username;

/**
* 一个简单的邮件发送
*/
@Test
public void sendSimpleMail(){
SimpleMailMessage message = new SimpleMailMessage();
// 设定邮件参数
message.setFrom(username); // 发送者 (注意:String 与 username 保持一致)
message.setTo("target@qq.com"); // 接受者
message.setSubject("主题:邮件"); // 标题
message.setText("邮件内容"); // 邮件内容

// 发送邮件
javaMailSender.send(message);
}

}

结果

到这里,一个简单的邮件发送就完成了,运行一下该单元测试,看看效果如何?

简单邮件 - 控制类

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
/**
* @author Ray
* @date 2018/7/27 0027
*/
@RestController
public class MailController {

private final Logger logger = LoggerFactory.getLogger(this.getClass());

@Value("${spring.mail.username}")
private String username;

@Autowired
private JavaMailSender javaMailSender;

/**
* 一个简单的邮件发送
*/
@RequestMapping("/sendMail")
public String sendMail(){
SimpleMailMessage message = new SimpleMailMessage();
message.setFrom(username);
message.setTo("target@qq.com");
message.setSubject("标题");
message.setText("Hello MailController~");
try{
javaMailSender.send(message);
logger.info("简单邮件已经发送!");
}catch (Exception e){
logger.error("发送简单邮件时发送异常!", e);
}
return "success";
}
}

结果


进阶示例

在上例中,我们通过使用SimpleMailMessage实现了简单的邮件发送,但是实际使用过程中,我们还可能会带上附件、或是使用邮件模块等。这个时候我们就需要使用MimeMessage来设置复杂一些的邮件内容,下面我们就来依次实现一下。

嵌入静态资源邮件

除了发送附件之外,我们在邮件内容中可能希望通过嵌入图片等静态资源,让邮件获得更好的阅读体验,而不是从附件中查看具体图片,下面的测试用例演示了如何通过MimeMessageHelper实现在邮件正文中嵌入静态资源。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/**
* 发送html内容
*/
@Test
public void sendMail1() throws MessagingException, UnsupportedEncodingException {

MimeMessage mimeMessage = javaMailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
helper.setFrom(new InternetAddress(username, "Ray", "UTF-8"));
helper.setTo("target@qq.com");
helper.setSubject("主题:Html内容");
StringBuffer stringBuffer = new StringBuffer();
stringBuffer
.append("<html><body>")
.append("<h2>Hello Ray~</h2>")
.append("</body></html");

helper.setText(stringBuffer.toString(), true);

javaMailSender.send(mimeMessage);
}

结果

发送带附件邮件

通过MimeMessageHelper来发送一封带有附件的邮件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/**
* 发送一封带有附件的邮件
*/
@Test
public void sendMail2() throws MessagingException {

MimeMessage mimeMessage = javaMailSender.createMimeMessage();

MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
helper.setFrom(username);
helper.setTo("target@qq.com");
helper.setSubject("主题:嵌入静态资源");
// 注意<img/>标签,src='cid:jpg','cid'是contentId的缩写,'jpg'是一个标记
helper.setText("<html><body><img src=\"cid:jpg\"></body></html", true);
// 加载文件资源,作为附件
FileSystemResource file = new FileSystemResource(new File("F:/test/2.jpg"));
helper.addInline("jpg", file);

// 发送邮件
javaMailSender.send(mimeMessage);
}

结果

-------------- 本文结束  感谢您的阅读 --------------