【JavaMail】SpringBoot集成JavaMail

前言：

工作生活中，經常會用郵件告知收件人，例如我們經常碰到的注冊驗證郵件。早期大家都用JavaMail相關的API來寫發送郵件，后來spring推出JavaMailSender簡化了郵件發送過程（有興趣的朋友可以自行研究一下JavaMailSender這個接口），再之后springBoot對此封裝有了現在的spring-boot-starter-mail。

JavaMail是Sun定義的一套收發電子郵件的API，是JavaEE一部分。JavaMailSender底層也是基於JavaMailjar包的。

通信協議：

SMTP：簡單郵件傳輸協議，用於發送電子郵件的傳輸協議；
POP3：用於接收電子郵件的標准協議；
IMAP：互聯網消息協議，是POP3的替代協議。
這三種協議都有對應SSL加密傳輸的協議，分別是SMTPS，POP3S和IMAPS。除JavaMail服務提供程序之外，JavaMail還需要JAF(JavaBeans Activation Framework)來處理不是純文本的郵件內容，這包括MIME（多用途互聯網郵件擴展）、URL頁面和文件附件等內容。

正文：

JavaMail中的關鍵對象。

Properties：屬性對象。針對不同的的郵件協議，JavaMail規定了服務提供者必須支持一系列屬性。

Session：會話對象。和web中的session不一樣的，簡單來說，它就是配置的集合。
Session的主要作用包括兩個方面：

接收各種配置屬性信息：通過Properties對象設置的屬性信息；
初始化JavaMail環境：根據JavaMail的配置文件，初始化JavaMail環境，以便通過Session對象創建其他重要類的實例。

Transport和Store：傳輸和存儲郵件操作只有發送或接收兩種處理方式，JavaMail將這兩種不同操作描述為傳輸（javax.mail.Transport）和存儲（javax.mail.Store），傳輸對應郵件的發送，而存儲對應郵件的接收。

Message：消息對象一旦獲得Session對象，就可以繼續創建要發送的消息。Message是個抽象類,常用的實現類為:javax.mail.internet.MimeMessage。

Address：創建了Session和Message，並將內容填入消息后，就可以用Address確定信件地址了。Address也是個抽象類。對應常用實現類：javax.mail.internet.InternetAddress。

Spring封裝后，使用起來基本上都不需要去關心這些對象值了，簡單了解下即可。

 SpringBoot集成

 pom包配置

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

MailServiceImpl

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Component;

import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.io.File;

@Component
public class MailServiceImpl implements MailService{
    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired
    private JavaMailSender mailSender;

    @Value("${mail.sender:[e-mail]}")
    private String from;
    @Override
    public void sendSimpleMail(String to, String subject, String content) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setFrom(from);
        message.setTo(to);
        message.setSubject(subject);
        message.setText(content);
        try {
            mailSender.send(message);
            logger.info("簡單郵件已經發送。");
        } catch (Exception e) {
            logger.error("發送簡單郵件時發生異常！", e);
        }
    }

    @Override
    public void sendHtmlMail(String to, String subject, String content) {
        MimeMessage message = mailSender.createMimeMessage();

        try {
            //true表示需要創建一個multipart message
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            helper.setFrom(from);
            helper.setTo(to);
            helper.setSubject(subject);
            helper.setText(content, true);

            mailSender.send(message);
            logger.info("html郵件發送成功");
        } catch (MessagingException e) {
            logger.error("發送html郵件時發生異常！", e.getMessage());
        }

    }

    @Override
    public void sendAttachmentsMail(String to, String subject, String content, String filePath) {
        MimeMessage message = mailSender.createMimeMessage();

        try {
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            helper.setFrom(from);
            helper.setTo(to);
            helper.setSubject(subject);
            helper.setText(content, true);

            File file = new File(filePath);
            //獲取文件名
            String fileName = file.getAbsolutePath().substring(file.getAbsolutePath().lastIndexOf("/")+1);
            helper.addAttachment(fileName, file);
            mailSender.send(message);
            logger.info("帶附件的郵件已經發送。");
        } catch (MessagingException e) {
            logger.error("發送帶附件的郵件時發生異常！", e);
        }
    }

    @Override
    public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId) {
        MimeMessage message = mailSender.createMimeMessage();

        try {
            MimeMessageHelper helper = new MimeMessageHelper(message, true);
            helper.setFrom(from);
            helper.setTo(to);
            helper.setSubject(subject);
            helper.setText(content, true);

            FileSystemResource res = new FileSystemResource(new File(rscPath));
            helper.addInline(rscId, res);

            mailSender.send(message);
            logger.info("嵌入靜態資源的郵件已經發送。");
        } catch (MessagingException e) {
            logger.error("發送嵌入靜態資源的郵件時發生異常！", e);
        }
    }
}

application.properties

（QQ郵箱郵箱授權碼獲取放式：設置->用戶->POP3/SMTP服務:開啟）

#設置郵件發送人
mail.sender = XXX
# JavaMailSender 郵件發送的配置
spring.mail.host=smtp.qq.com
spring.mail.username=xxx
spring.mail.properties.mail.smtp.socketFactory.port = 465
spring.mail.properties.mail.smtp.socketFactory.class = javax.net.ssl.SSLSocketFactory
spring.mail.properties.mail.smtp.socketFactory.fallback = false
#QQ郵箱的授權碼
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.default-encoding=UTF-8
#freemarker配置
spring.freemarker.content-type=text/html
spring.freemarker.suffix=.ftl
spring.freemarker.template-loader-path=classpath:/templates
spring.freemarker.charset=UTF-8
spring.freemarker.check-template-location=true

 

測試代碼：

發送簡單郵件

mport com.example.java.mail.MailService;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes= JavaApplication.class) //啟動類名
@EnableAutoConfiguration
public class Test {

    @Autowired
    private MailService mailService;

    @org.junit.Test
    public void testSimpleMail() throws Exception {
        mailService.sendSimpleMail("[e-mail]","測試郵件"," hello this is simple mail");
    }
}

 發送HTML格式郵件

　　@Test
    public void testHtmlMail() throws Exception {
        String content="<html>\n" +
                "<body>\n" +
                "    <h3>hello world ! 這是一封html郵件!</h3>\n" +
                "</body>\n" +
                "</html>";
        mailService.sendHtmlMail("[e-mail]","test simple mail",content);
    }

發送帶附件的郵件

    @Test
    public void sendAttachmentsMail() {
        String filePath="./test-output/index.html";
        mailService.sendAttachmentsMail("[e-mail]", "主題：帶附件測試報告的郵件", "有附件測試報告，請查收！", filePath);
    }

發送靜態資源

    @Test
    public void sendInlineResourceMail() {
        String rscId = "test";
        String content="<html><body>這是有圖片的郵件：<img src=\'cid:" + rscId + "\' ></body></html>";
        String imgPath = "/Users/apple/Downloads/圖片/ads-beverage-black-coffee-33972.jpg";

        mailService.sendInlineResourceMail("[e-mail]", "主題：這是有圖片的郵件", content, imgPath, rscId);
    }