SpringBoot基礎(chǔ)教程之集成郵件服務(wù)

更新時(shí)間：2020年07月28日 08:56:24 作者：JMCui

這篇文章主要給大家介紹了關(guān)于SpringBoot基礎(chǔ)教程之集成郵件服務(wù)的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者使用SpringBoot具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

一、前言

Spring Email 抽象的核心是 MailSender 接口，MailSender 的實(shí)現(xiàn)能夠把 Email 發(fā)送給郵件服務(wù)器，由郵件服務(wù)器實(shí)現(xiàn)郵件發(fā)送的功能。

Spring 自帶了一個(gè) MailSender 的實(shí)現(xiàn) JavaMailSenderImpl，它會(huì)使用 JavaMail API 來(lái)發(fā)送 Email。Spring 或 SpringBoot 應(yīng)用在發(fā)送 Email 之前，我們必須要 JavaMailSenderImpl 裝配為 Spring應(yīng)用上下文的一個(gè) 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 屬性默認(rèn)是 JavaMail 會(huì)話的主機(jī)；port 端口默認(rèn)監(jiān)聽(tīng)標(biāo)準(zhǔn)的 SMTP 端口25；如果郵件服務(wù)器需要認(rèn)證的，還需要設(shè)置 userrname 和 password。

這里我用的是 163 的郵件服務(wù)器，需要在 163 郵箱中開(kāi)啟客戶端授權(quán)密碼，否則會(huì)報(bào) 550 認(rèn)證錯(cuò)誤。

3、EmailConfig.java

在這里，我們把 JavaMailSenderImpl 裝配為 Spring 應(yīng)用上下文的一個(gè) Bean。同時(shí)需要注意的是，這里使用了@ConfigurationProperties 注解，該注解需要屬性有 setter 方法并在啟動(dòng)類(lèi)中使用 @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;
  }
}

三、發(fā)送

有了 javaMailSender，那么郵件發(fā)送就是一件再簡(jiǎn)單不過(guò)的事情了。我們只需要將 javaMailSender 的 Bean 注入到我們自己的實(shí)現(xiàn)類(lèi)中，然后使用 JavaMail API 來(lái)發(fā)送 Email。

1、文本郵件發(fā)送

public void sendSimpleEmail() {
  // 構(gòu)造Email消息
  SimpleMailMessage message = new SimpleMailMessage();
  message.setFrom("159****2662@163.com");
  message.setTo("****@qianxx.com");
  message.setSubject("郵件主題");
  message.setText("郵件內(nèi)容");
  javaMailSender.send(message);
}

純文本的 Email 在于構(gòu)造 SimpleMailMessage 實(shí)例，這個(gè)對(duì)象可以很便捷地發(fā)送Email消息。

2、附件郵件發(fā)送

Spring 的 Email 功能并不局限于純文本的 Email。我們還可以添加附件。如果要發(fā)送帶有附件的 Email，關(guān)鍵技巧是創(chuàng)建 multipart 類(lèi)型的消息 ———— Email由多個(gè)部分組成，其中一部分是 Email 體，其他部分是附件。為了發(fā)送 multipart 類(lèi)型的 Email，你需要?jiǎng)?chuàng)建一個(gè)MIME（Multipurpose Internet Mail Extensions）的消息。

public void mimeEmail() throws MessagingException {
  // MimeMessage 本身的 API 有些笨重，我們可以使用 MimeMessageHelper
  MimeMessage mimeMessage = javaMailSender.createMimeMessage();
  // 第二個(gè)參數(shù)是 true ，表明這個(gè)消息是 multipart類(lèi)型的/
  MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
  mimeMessageHelper.setFrom("159****2662@163.com");
  mimeMessageHelper.setTo("****@qianxx.com");
  mimeMessageHelper.setSubject("附件郵件主題");
  mimeMessageHelper.setText("附件郵件內(nèi)容");
  //添加附件,第一個(gè)參數(shù)表示添加到 Email 中附件的名稱(chēng)，第二個(gè)參數(shù)是圖片資源
  mimeMessageHelper.addAttachment("boot.png", new ClassPathResource("public/images/boot.png"));
  javaMailSender.send(mimeMessage);
}

3、富文本郵件發(fā)送

Spring 的 Email 功能除了可以添加附件外，甚至可以使用 HTML 來(lái)美化消息體的內(nèi)容。發(fā)送富文本的 Email 與發(fā)送簡(jiǎn)單文本的 Email 并沒(méi)有太大區(qū)別，關(guān)鍵是將setText() 方法的消息文本設(shè)置為 HTML，并將第二個(gè)參數(shù)設(shè)置為 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);
  // 設(shè)置內(nèi)嵌元素 cid，第一個(gè)參數(shù)表示內(nèi)聯(lián)圖片的標(biāo)識(shí)符，第二個(gè)參數(shù)標(biāo)識(shí)資源引用
  mimeMessageHelper.addInline("boot", new ClassPathResource("public/images/boot.png"));
  javaMailSender.send(mimeMessage);
}

四、使用 Thymeleaf 模板

HTML 標(biāo)簽的字符串拼接是一件很棘手的事。因?yàn)樵谀愕拇竽X中解析HTML標(biāo)簽并想象它在渲染時(shí)會(huì)是什么樣子是挺困難的。而將HTML混合在Java代碼中又會(huì)使得這個(gè)問(wèn)題更加復(fù)雜。

因此 Spring 給出的解決方案是：使用模板生成 HTML 文本，有多種模板方案可供選擇，包括Apache Velocity和Thymeleaf。這里僅介紹 Thymeleaf 模板的用法（假設(shè)讀者已經(jīng)熟悉了 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、郵件發(fā)送

@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 模板構(gòu)建 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);
    // 設(shè)置內(nèi)嵌元素 cid，第一個(gè)參數(shù)表示內(nèi)聯(lián)圖片的標(biāo)識(shí)符，第二個(gè)參數(shù)標(biāo)識(shí)資源引用
    mimeMessageHelper.addInline("boot", new ClassPathResource("/static/img/boot.png"));
    javaMailSender.send(mimeMessage);
  }
}

演示源代碼：https://github.com/JMCuixy/Boot

總結(jié)

到此這篇關(guān)于SpringBoot基礎(chǔ)教程之集成郵件服務(wù)的文章就介紹到這了,更多相關(guān)SpringBoot集成郵件服務(wù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: