一、前言
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); } }