SpringBoot基础教程之集成邮件服务
作者：JMCui
一、前言
Spring Email 抽象的核心是 MailSender 接口，MailSender 的实现能够把 Email 发送给邮件服务器，由邮件服务器实现邮件发送的功能。
Spring 自带了一个 MailSender 的实现 JavaMailSenderImpl，它会使用 JavaMail API 来发送 Email。Spring 或 SpringBoot 应用在发送 Email 之前，我们必须要 JavaMailSenderImpl 装配为 Spring应用上下文的一个 bean。
二、配置
1、pom.xml
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency>
2、application.yml
spring: mail: host: smtp.163.com port: 25 username: 159****2662@163.com password: ***********
host 属性默认是 JavaMail 会话的主机；port 端口默认监听标准的 SMTP 端口25；如果邮件服务器需要认证的，还需要设置 userrname 和 password。
这里我用的是 163 的邮件服务器，需要在 163 邮箱中开启客户端授权密码，否则会报 550 认证错误。
3、EmailConfig.java
在这里，我们把 JavaMailSenderImpl 装配为 Spring 应用上下文的一个 Bean。同时需要注意的是，这里使用了@ConfigurationProperties 注解，该注解需要属性有 setter 方法并在启动类中使用 @EnableConfigurationProperties 注解使之生效。
@Configuration
@ConfigurationProperties(prefix = "spring.mail")
public class EmailConfig {
private String host;
private Integer port;
private String username;
private String password;
@Bean
public MailSender javaMailSender() {
JavaMailSenderImpl javaMailSender = new JavaMailSenderImpl();
javaMailSender.setHost(host);
javaMailSender.setPort(port);
javaMailSender.setUsername(username);
javaMailSender.setPassword(password);
return javaMailSender;
}
public void setHost(String host) {
this.host = host;
}
public void setPort(Integer port) {
this.port = port;
}
public void setUsername(String username) {
this.username = username;
}
public void setPassword(String password) {
this.password = password;
}
}
三、发送
有了 javaMailSender，那么邮件发送就是一件再简单不过的事情了。我们只需要将 javaMailSender 的 Bean 注入到我们自己的实现类中，然后使用 JavaMail API 来发送 Email。
1、文本邮件发送
public void sendSimpleEmail() {
// 构造Email消息
SimpleMailMessage message = new SimpleMailMessage();
message.setFrom("159****2662@163.com");
message.setTo("****@qianxx.com");
message.setSubject("邮件主题");
message.setText("邮件内容");
javaMailSender.send(message);
}
纯文本的 Email 在于构造 SimpleMailMessage 实例，这个对象可以很便捷地发送Email消息。
2、附件邮件发送
Spring 的 Email 功能并不局限于纯文本的 Email。我们还可以添加附件。如果要发送带有附件的 Email，关键技巧是创建 multipart 类型的消息 ———— Email由多个部分组成，其中一部分是 Email 体，其他部分是附件。为了发送 multipart 类型的 Email，你需要创建一个MIME（Multipurpose Internet Mail Extensions）的消息。
public void mimeEmail() throws MessagingException {
// MimeMessage 本身的 API 有些笨重，我们可以使用 MimeMessageHelper
MimeMessage mimeMessage = javaMailSender.createMimeMessage();
// 第二个参数是 true ，表明这个消息是 multipart类型的/
MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
mimeMessageHelper.setFrom("159****2662@163.com");
mimeMessageHelper.setTo("****@qianxx.com");
mimeMessageHelper.setSubject("附件邮件主题");
mimeMessageHelper.setText("附件邮件内容");
//添加附件,第一个参数表示添加到 Email 中附件的名称，第二个参数是图片资源
mimeMessageHelper.addAttachment("boot.png", new ClassPathResource("public/images/boot.png"));
javaMailSender.send(mimeMessage);
}
3、富文本邮件发送
Spring 的 Email 功能除了可以添加附件外，甚至可以使用 HTML 来美化消息体的内容。发送富文本的 Email 与发送简单文本的 Email 并没有太大区别，关键是将setText() 方法的消息文本设置为 HTML，并将第二个参数设置为 true，表示这是 HTML 的富文本。
public void htmlEmail() throws MessagingException {
MimeMessage mimeMessage = javaMailSender.createMimeMessage();
MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
mimeMessageHelper.setFrom("159****2662@163.com");
mimeMessageHelper.setTo("****@qianxx.com");
mimeMessageHelper.setSubject("富文本邮件主题");
String html = "<html><body><h4>Hello,SpringBoot</h4><img src='cid:boot' /></body></html>";
mimeMessageHelper.setText(html, true);
// 设置内嵌元素 cid，第一个参数表示内联图片的标识符，第二个参数标识资源引用
mimeMessageHelper.addInline("boot", new ClassPathResource("public/images/boot.png"));
javaMailSender.send(mimeMessage);
}
四、使用 Thymeleaf 模板
HTML 标签的字符串拼接是一件很棘手的事。因为在你的大脑中解析HTML标签并想象它在渲染时会是什么样子是挺困难的。而将HTML混合在Java代码中又会使得这个问题更加复杂。
因此 Spring 给出的解决方案是：使用模板生成 HTML 文本，有多种模板方案可供选择，包括Apache Velocity和Thymeleaf。这里仅介绍 Thymeleaf 模板的用法（假设读者已经熟悉了 Thymeleaf 模板并知道如何在 SpringBoot 中使用它们）。
1、Thymeleaf 模板 — email.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Email</title>
</head>
<body>
<img src='cid:boot'>
<h4><span th:text="${title}">Craig Walls</span> says... </h4>
<i><span th:text="${content}">Hello Boot!</span></i>
</body>
</html>
2、邮件发送
@RunWith(SpringRunner.class)
@SpringBootTest
public class ThymeleafApplicationTests {
@Autowired
private JavaMailSender javaMailSender;
@Autowired
private SpringTemplateEngine templateEngine;
@Test
public void contextLoads() throws MessagingException {
MimeMessage mimeMessage = javaMailSender.createMimeMessage();
MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
mimeMessageHelper.setFrom("159****2662@163.com");
mimeMessageHelper.setTo("****@qianxx.com");
mimeMessageHelper.setSubject("ThymeLeaf 模板邮件");
// 利用 Thymeleaf 模板构建 html 文本
Context ctx = new Context();
ctx.setVariable("title", "Craig Walls");
ctx.setVariable("content", "Hello Boot!");
String emailText = templateEngine.process("email/email", ctx);
mimeMessageHelper.setText(emailText, true);
// 设置内嵌元素 cid，第一个参数表示内联图片的标识符，第二个参数标识资源引用
mimeMessageHelper.addInline("boot", new ClassPathResource("/static/img/boot.png"));
javaMailSender.send(mimeMessage);
}
}
演示源代码：https://github.com/JMCuixy/Boot
总结
到此这篇关于SpringBoot基础教程之集成邮件服务的文章就介绍到这了,更多相关SpringBoot集成邮件服务内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！