springboot集成郵件服務

時間 2020-05-08

原文原文鏈接

1、前言

Spring Email 抽象的核心是 MailSender 接口，MailSender 的實現可以把 Email 發送給郵件服務器，由郵件服務器實現郵件發送的功能。html

Spring 自帶了一個 MailSender 的實現 JavaMailSenderImpl，它會使用 JavaMail API 來發送 Email。Spring 或 SpringBoot 應用在發送 Email 以前，咱們必需要 JavaMailSenderImpl 裝配爲 Spring應用上下文的一個 bean。java

回到頂部

2、配置

一、pom.xml

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

二、application.yml

spring:
  mail:
    host: smtp.163.com
    port: 25
    username: 159****2662@163.com
    password: ***********

host 屬性默認是 JavaMail 會話的主機；port 端口默認監聽標準的 SMTP 端口25；若是郵件服務器須要認證的，還須要設置 userrname 和 password。spring

這裏我用的是 163 的郵件服務器，須要在 163 郵箱中開啓客戶端受權密碼，不然會報 550 認證錯誤。服務器

三、EmailConfig.java

在這裏，咱們把 JavaMailSenderImpl 裝配爲 Spring 應用上下文的一個 Bean。同時須要注意的是，這裏使用了@ConfigurationProperties 註解，該註解須要屬性有 setter 方法並在啓動類中使用 @EnableConfigurationProperties 註解使之生效。app

@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;
    }
}

回到頂部

3、發送

有了 javaMailSender，那麼郵件發送就是一件再簡單不過的事情了。咱們只須要將 javaMailSender 的 Bean 注入到咱們本身的實現類中，而後使用 JavaMail API 來發送 Email。spring-boot

一、文本郵件發送

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消息。ui

二、附件郵件發送

Spring 的 Email 功能並不侷限於純文本的 Email。咱們還能夠添加附件。若是要發送帶有附件的 Email，關鍵技巧是建立 multipart 類型的消息 ———— Email由多個部分組成，其中一部分是 Email 體，其餘部分是附件。爲了發送 multipart 類型的 Email，你須要建立一個MIME（Multipurpose Internet Mail Extensions）的消息。this

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);
}

三、富文本郵件發送

Spring 的 Email 功能除了能夠添加附件外，甚至可使用 HTML 來美化消息體的內容。發送富文本的 Email 與發送簡單文本的 Email 並無太大區別，關鍵是將setText() 方法的消息文本設置爲 HTML，並將第二個參數設置爲 true，表示這是 HTML 的富文本。spa

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);
}

回到頂部

4、使用 Thymeleaf 模板

HTML 標籤的字符串拼接是一件很棘手的事。由於在你的大腦中解析HTML標籤並想象它在渲染時會是什麼樣子是挺困難的。而將HTML混合在Java代碼中又會使得這個問題更加複雜。code

所以 Spring 給出的解決方案是：使用模板生成 HTML 文本，有多種模板方案可供選擇，包括Apache Velocity和Thymeleaf。這裏僅介紹 Thymeleaf 模板的用法（假設讀者已經熟悉了 Thymeleaf 模板並知道如何在 SpringBoot 中使用它們）。

一、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>

二、郵件發送

@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);
    }
}

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。