相信使用過Spring的眾多開發者都知道Spring提供了非常好用的JavaMailSender介面實現郵件發送，在Spring Boot的Starter模塊中也為此提供了自動化配置。下麵通過實例來講解如何在Spring Boot中使用JavaMailSender發送郵件。什麼是SMTP？ SM ...

相信使用過Spring的眾多開發者都知道Spring提供了非常好用的JavaMailSender介面實現郵件發送，在Spring Boot的Starter模塊中也為此提供了自動化配置。

下麵通過實例來講解如何在Spring Boot中使用JavaMailSender發送郵件。

什麼是SMTP？

SMTP全稱為Simple Mail Transfer Protocol（簡單郵件傳輸協議），它是一組用於從源地址到目的地址傳輸郵件的規範，通過它來控制郵件的中轉方式。SMTP認證要求必須提供賬號和密碼才能登陸伺服器，其設計目的在於避免用戶受到垃圾郵件的侵擾。

什麼是POP3？

POP3全稱為Post Office Protocol 3（郵局協議）,POP3支持客戶端遠程管理伺服器端的郵件。POP3常用於“離線”郵件處理，即允許客戶端下載伺服器郵件，然後伺服器上的郵件將會被刪除。目前很多POP3的郵件伺服器只提供下載郵件功能，伺服器本身並不刪除郵件，這種屬於改進版的POP3協議。

傳輸協議

SMTP協議
發送郵件：我們通常把處理用戶smtp請求(郵件發送請求)的伺服器稱之為SMTP伺服器(郵件發送伺服器)。

POP3協議
接收郵件：我們通常把處理用戶pop3請求(郵件接收請求)的伺服器稱之為POP3伺服器(郵件接收伺服器)。

進階知識

什麼是JavaMailSender和JavaMailSenderImpl？

JavaMailSender和JavaMailSenderImpl 是Spring官方提供的集成郵件服務的介面和實現類，以簡單高效的設計著稱，目前是Java後端發送郵件和集成郵件服務的主流工具。

如何通過JavaMailSenderImpl發送郵件？‘

非常簡單，直接在業務類註入JavaMailSenderImpl並調用send方法發送郵件。其中簡單郵件可以通過SimpleMailMessage來發送郵件，而複雜的郵件（例如添加附件）可以藉助MimeMessageHelper來構建MimeMessage發送郵件。

e,g:

    @Autowired
    private JavaMailSenderImpl mailSender;

    public void sendMail() throws MessagingException {
        //簡單郵件
        SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
        simpleMailMessage.setFrom("[email protected]");
        simpleMailMessage.setTo("[email protected]");
        simpleMailMessage.setSubject("Happy New Year");
        simpleMailMessage.setText("新年快樂！");
        mailSender.send(simpleMailMessage);

        //複雜郵件
        MimeMessage mimeMessage = mailSender.createMimeMessage();
        MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage);
        messageHelper.setFrom("[email protected]");
        messageHelper.setTo("[email protected]");
        messageHelper.setSubject("Happy New Year");
        messageHelper.setText("新年快樂！");
        messageHelper.addInline("doge.gif", new File("xx/xx/doge.gif"));
        messageHelper.addAttachment("work.docx", new File("xx/xx/work.docx"));
        mailSender.send(mimeMessage);
    }

為什麼JavaMailSenderImpl 能夠開箱即用？

所謂開箱即用其實就是基於官方內置的自動配置，翻看源碼可知曉郵件自動配置類(MailSenderPropertiesConfiguration) 為上下文提供了郵件服務實例(JavaMailSenderImpl)。具體源碼如下：

@Configuration
@ConditionalOnProperty(prefix = "spring.mail", name = "host")
class MailSenderPropertiesConfiguration {
    private final MailProperties properties;
    MailSenderPropertiesConfiguration(MailProperties properties) {
        this.properties = properties;
    }
    @Bean
    @ConditionalOnMissingBean
    public JavaMailSenderImpl mailSender() {
        JavaMailSenderImpl sender = new JavaMailSenderImpl();
        applyProperties(sender);
        return sender;
 }

其中MailProperties是關於郵件伺服器的配置信息，具體源碼如下：

@ConfigurationProperties(prefix = "spring.mail")
public class MailProperties {
    private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
    private String host;
    private Integer port;
    private String username;
    private String password;
    private String protocol = "smtp";
    private Charset defaultEncoding = DEFAULT_CHARSET;
    private Map<String, String> properties = new HashMap<>();
}

實現

1.開啟郵件服務

這裡以QQ郵箱為例。

首先登錄QQ郵箱>>>登錄成功後找到設置>>>然後找到郵箱設置>>>點擊賬戶>>>找到POP3|SMTP服務>>>點擊開啟(開啟需要驗證，驗證成功後會有一串授權碼用於發送郵件使用)>>>驗證成功

引入依賴

在springboot項目中，引入如下依賴：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.galaxy</groupId>
    <artifactId>MailSender</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>MailSender</name>
    <description>MailSender</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

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

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

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.10</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

application.yml配置

在配置文件application.yml文件中寫入發送郵件的配置信息

# 服務埠
server:
  port: 8083

spring:
  #郵箱基本配置
  mail:
    #配置smtp服務主機地址
    # qq郵箱為smtp.qq.com          埠號465或587
    # sina    smtp.sina.cn
    # aliyun  smtp.aliyun.com
    # 163     smtp.163.com       埠號465或994
    host: smtp.qq.com
    #發送者郵箱
    username: [email protected]
    #配置密碼,註意不是真正的密碼，而是剛剛申請到的授權碼
    password: gltiixjllkakxobfjd
    #埠號465或587
    port: 587
    #預設的郵件編碼為UTF-8
    default-encoding: UTF-8
    #其他參數
    properties:
     mail:
        #配置SSL 加密工廠
      smtp:
        ssl:
          #本地測試，先放開ssl
          enable: false
          required: false
        #開啟debug模式，這樣郵件發送過程的日誌會在控制台列印出來，方便排查錯誤
      debug: true

註:配置 SpringBoot 啟動埠還可以通過IDEA 本身的配置來指定啟動埠

第一步
第二步

編寫發送郵件方法

編寫郵件業務類MailService.

主要通過MailService工具類就可以滿足發送java郵件的需要。當我們進行好 yml 配置後，SpringBoot會幫助我們自動配置 JavaMailSender 我們通過這個java類就可以實現操作java來發送郵件。

發送純文本郵件

service

package com.galaxy.mailsender.service;



import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.mail.javamail.JavaMailSenderImpl;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Service;
import javax.mail.MessagingException;
import java.util.Date;

/**
 * 郵件業務類
 * @author Galaxy
 */
@Service
public class MailService {
    /**
     * 註入郵件工具類
     */
    @Autowired
    private JavaMailSenderImpl javaMailSender;

    @Value("${spring.mail.username}")
    private String sendMailer;

    /**
     * 檢測郵件信息類
     * @param to
     * @param subject
     * @param text
     */
    private void checkMail(String to,String subject,String text){
        if(StringUtils.isEmpty(to)){
            throw new RuntimeException("郵件收信人不能為空");
        }
        if(StringUtils.isEmpty(subject)){
            throw new RuntimeException("郵件主題不能為空");
        }
        if(StringUtils.isEmpty(text)){
            throw new RuntimeException("郵件內容不能為空");
        }
    }

    /**
     * 發送純文本郵件
     * @param to
     * @param subject
     * @param text
     */
    public void sendTextMailMessage(String to,String subject,String text){

        try {
            //true 代表支持複雜的類型
            MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(javaMailSender.createMimeMessage(),true);
            //郵件發信人
            mimeMessageHelper.setFrom(sendMailer);
            //郵件收信人  1或多個
            mimeMessageHelper.setTo(to.split(","));
            //郵件主題
            mimeMessageHelper.setSubject(subject);
            //郵件內容
            mimeMessageHelper.setText(text);
            //郵件發送時間
            mimeMessageHelper.setSentDate(new Date());

            //發送郵件
            javaMailSender.send(mimeMessageHelper.getMimeMessage());
            System.out.println("發送郵件成功："+sendMailer+"->"+to);

        } catch (MessagingException e) {
            e.printStackTrace();
            System.out.println("發送郵件失敗："+e.getMessage());
        }
    }
}

Controller

package com.galaxy.mailsender.controller;

import com.galaxy.mailsender.service.MailService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MailController {
    @Autowired
    private MailService mailService;


    /**
     * 發送文本郵件
     * @param to
     * @param subject
     * @param text
     */
    @RequestMapping("/sendTextMail")
    public void sendTextMail(String to,String subject,String text){
        mailService.sendTextMailMessage(to,subject,text);
    }
}

測試

結果

補充

發送html郵件

Spring Boot支持使用HTML發送郵件是通過MimeMessage來完成的。

發送帶附件的郵件

MimeMessageHelper支持發送複雜郵件模板，支持文本、附件、HTML、圖片等。比如需要發送附件，則在上面的代碼中通過調用helper的addAttachment(fileName, file)方法即可。

例:發送HTML郵件

package com.example.emaildemo.controller;

import com.example.emaildemo.service.MailService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 測試郵件發送
 * @author galaxy
 */
@RestController
public class SendMailController {

    @Autowired
    private MailService mailService;
    /**
     * 發送HTML郵件
     * @param to
     * @param subject
     * @param content
     */
    @RequestMapping("/sendHtmlMailMessage")
    public void sendHtmlMailMessage(String to,String subject,String content){
        mailService.sendHtmlMailMessage(to,subject,content);
    }
}

SpringBoot-JavaMailSender介面實戰