SpringBoot基礎教程之整合郵件服務
一、前言
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****[email protected] 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****[email protected]");
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****[email protected]");
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****[email protected]");
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****[email protected]");
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整合郵件服務內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！