11：SpringBoot整合JavaMail實現郵

11：SpringBoot整合JavaMail實現郵件發送功能

avaMail是SUN提供給廣大Java開發人員的一款郵件發送和接受的一款開源類庫，支持常用的郵件協議，如：SMTP、POP3、IMAP，開發人員使用JavaMail編寫郵件程序時，不再需要考慮底層的通訊細節如：Socket而是關注在邏輯層面。JavaMail可以發送各種復雜MIME格式的郵件內容，注意JavaMail僅支持JDK4及以上版本。雖然JavaMail是JDK的API但它并沒有直接加入JDK中，所以我們需要另外添加依賴，下面我們開始講解本章的內容。

本章目標

將Java提供的JavaMail類庫與SpringBoot項目進行整合，并且簡單封裝下JavaMail類庫。

構建項目

本章項目無關Web相關內容，所以創建項目時選擇Jar形式創建，并且不需要預先導入依賴。項目結構如下圖1所示：

圖1

可以看到上圖1內容，多余的依賴并沒有添加，如果你選擇的是War項目也沒有關系名，那好，我們接下來把我們的主角JavaMail請出來吧，把對應的依賴添加到pom.xml配置文件內。如下圖2所示：

圖2

依賴我們已經導入成功了，接下來我們開始編寫JavaMail的封裝，我這里簡單的對JavaMail做出封裝，如果您需要更完美的封裝，請對我的代碼做出修改即可，先來編寫一個MailEntity類來保存發送郵件時需要的參數字段，如下圖3所示：

圖3

我們的MailEntity包含了上圖3的字段內容，都是一些必填選項，下面我們來創建一個MailSender也就是郵件發送者實體，主要作用就是用來配置發送郵件參數以及執行發送郵件，代碼如下圖4、5、6、7、8所示：

圖4

圖5

圖6

圖7

圖8

下次編寫文章使用MarkDown方式來寫，類過長貼起來圖挺費勁。上面可以看到我使用到了MailContentTypeEnum以及PropertiesUtil工具類。

MailContentTypeEnum

這是一個我自定義的枚舉類型，枚舉類型包含了郵件內容的類型，目前我僅僅添加了兩種，一種是html另外一種則是text形式，具體代碼如下圖9所示：

圖9

PropertiesUtil

PropertiesUtil是用于讀取*.properties配置文件的工具類，使用JavaMail需要配置SMTP以及用戶名、密碼等也就是MailEntity內的字段，那么我們在/resource目錄下創建一個名字叫mail.properties的配置文件，里面存放我們定義的郵件發送參數配置，這樣方便修改，我分別貼出PropertiesUtil、mail.properties代碼內容，如下圖10、圖11所示：

圖10

圖11

我使用的QQ郵箱地址作為測試，如果你需要使用你的QQ地址作為測試，請先到QQ郵箱開啟POP3/SMTP服務，開啟步驟如下。

開啟POP3/SMTP

第一步：進入郵箱點擊“設置”，如下圖12所示：

圖12

第二步：點擊“賬戶”后往下拉找到POP3/IMAP/SMTP...，如下圖13所示：

圖13

我的POP3以及SMTP以及開啟了所以這里顯示的狀態是已開啟，如果您第一次使用QQ郵箱的SMTP服務，請點擊“開啟”并且按照提示步驟完成獲取“授權碼”即可，授權碼就是發送郵件參數的smtp.pwd屬性。

測試發送郵件

我們創建一個TestMail類來作為測試入口，因為我們的項目是jar形式，所以我們直接新建一個main方法直接調用發送郵件就可以了，如下圖14所示測試代碼：

圖14

我是向我的釘釘郵箱發送了一條文本類型的測試郵件，發送效果圖如下圖15所示：

圖15

可以看到我們的郵件收到了，證明我們已經完成了郵件發送的功能了，但是你在發送中配置mail.properties文件時配置昵稱的時候最有可能出現的問題就是亂碼，那么該問題如何解決呢？

昵稱亂碼問題解決

第一步：修改InteiiJ IDEA工具的properties文件的編碼，點擊File->Setting->Editor->File Encodings將下面的Default encoding設置為UTF-8，如下圖16所示：

圖16

那么我們的mail.properties內使用ASCII編碼進行配置昵稱就可以了，具體中文如何轉換ASCII，請大家訪問tool.oschina.net/encode在線轉換即可。修改完成后再次測試發送郵件，你就會發現亂碼問題解決了。

總結

上述內容就是本章的所有講解，本章主要講解了在SpringBoot項目內是如何使用JavaMail來進行發送簡單郵件，簡單封裝了下MailSender類以及對象實體MailEntity，如果需要發送HTML內容的郵件修改contentType(MailContentTypeEnum.HTML)然后content("html代碼")即可。

本號已開設如下二十大專題，歡迎關注，查看相關專題！

【springboot專題】【spring源碼】
【mysql優化專題】【HTTP協議】
【架構技術專題】【多線程專題】
【dubbo專題】【dubbo源碼專題】
【JVM調優專題】【HTTP專題】
【設計模式專題】【高并發專題】
【架構技術專題】【Lucene專題】
【數據結構專題】【redis專題】
【mq中間件專題】【netty專題】
【java面試專題】【zookeeper】

使用Java應用程序發送E-mail十分簡單，但是首先你應該在你的機器上安裝JavaMail API 和Java Activation Framework (JAF) 。

你可以在 JavaMail (Version 1.2) 下載最新的版本。

你可以再在JAF (Version 1.1.1)下載最新的版本。

下載并解壓這些文件，最上層文件夾你會發現很多的jar文件。你需要將mail.jar和activation.jar 添加到你的CLASSPATH中。

如果你使用第三方郵件服務器如QQ的SMTP服務器，可查看文章底部用戶認證完整的實例。

發送一封簡單的 E-mail

下面是一個發送簡單E-mail的例子。假設你的localhost已經連接到網絡。

// 文件名 SendEmail.java

import java.util.*;import javax.mail.*;import javax.mail.internet.*;import javax.activation.*;

public class SendEmail{

public static void main(String [] args)

{

// 收件人電子郵箱

String to="abcd@gmail.com";

// 發件人電子郵箱

String from="web@gmail.com";

// 指定發送郵件的主機為 localhost

String host="localhost";

// 獲取系統屬性

Properties properties=System.getProperties();

// 設置郵件服務器

properties.setProperty("mail.smtp.host", host);

// 獲取默認session對象

Session session=Session.getDefaultInstance(properties);

try{

// 創建默認的 MimeMessage 對象

MimeMessage message=new MimeMessage(session);

// Set From: 頭部頭字段

message.setFrom(new InternetAddress(from));

// Set To: 頭部頭字段

message.addRecipient(Message.RecipientType.TO,

new InternetAddress(to));

// Set Subject: 頭部頭字段

message.setSubject("This is the Subject Line!");

// 設置消息體

message.setText("This is actual message");

// 發送消息

Transport.send(message);

System.out.println("Sent message successfully....");

}catch (MessagingException mex) {

mex.printStackTrace();

}

}}

編譯并運行這個程序來發送一封簡單的E-mail：

$ java SendEmailSent message successfully....

如果你想發送一封e-mail給多個收件人，那么使用下面的方法來指定多個收件人ID：

void addRecipients(Message.RecipientType type,

Address[] addresses)throws MessagingException

下面是對于參數的描述：

type:要被設置為TO, CC 或者BCC. 這里CC 代表抄送、BCC 代表秘密抄送y. 舉例：Message.RecipientType.TO
addresses: 這是email ID的數組。在指定電子郵件ID時，你將需要使用InternetAddress()方法。

發送一封HTML E-mail

下面是一個發送HTML E-mail的例子。假設你的localhost已經連接到網絡。

和上一個例子很相似，除了我們要使用setContent()方法來通過第二個參數為"text/html"，來設置內容來指定要發送HTML內容。

// 文件名 SendHTMLEmail.java

import java.util.*;import javax.mail.*;import javax.mail.internet.*;import javax.activation.*;

public class SendHTMLEmail{

public static void main(String [] args)

{

// 收件人電子郵箱

String to="abcd@gmail.com";

// 發件人電子郵箱

String from="web@gmail.com";

// 指定發送郵件的主機為 localhost

String host="localhost";

// 獲取系統屬性

Properties properties=System.getProperties();

// 設置郵件服務器

properties.setProperty("mail.smtp.host", host);

// 獲取默認的 Session 對象。

Session session=Session.getDefaultInstance(properties);

try{

// 創建默認的 MimeMessage 對象。

MimeMessage message=new MimeMessage(session);

// Set From: 頭部頭字段

message.setFrom(new InternetAddress(from));

// Set To: 頭部頭字段

message.addRecipient(Message.RecipientType.TO,

new InternetAddress(to));

// Set Subject: 頭字段

message.setSubject("This is the Subject Line!");

// 發送 HTML 消息, 可以插入html標簽

message.setContent("<h1>This is actual message</h1>",

"text/html" );

// 發送消息

Transport.send(message);

System.out.println("Sent message successfully....");

}catch (MessagingException mex) {

mex.printStackTrace();

}

}}

編譯并運行此程序來發送HTML e-mail：

$ java SendHTMLEmailSent message successfully....

發送帶有附件的 E-mail

下面是一個發送帶有附件的 E-mail的例子。假設你的localhost已經連接到網絡。

// 文件名 SendFileEmail.java

import java.util.*;import javax.mail.*;import javax.mail.internet.*;import javax.activation.*;

public class SendFileEmail{

public static void main(String [] args)

{

// 收件人電子郵箱

String to="abcd@gmail.com";

// 發件人電子郵箱

String from="web@gmail.com";

// 指定發送郵件的主機為 localhost

String host="localhost";

// 獲取系統屬性

Properties properties=System.getProperties();

// 設置郵件服務器

properties.setProperty("mail.smtp.host", host);

// 獲取默認的 Session 對象。

Session session=Session.getDefaultInstance(properties);

try{

// 創建默認的 MimeMessage 對象。

MimeMessage message=new MimeMessage(session);

// Set From: 頭部頭字段

message.setFrom(new InternetAddress(from));

// Set To: 頭部頭字段

message.addRecipient(Message.RecipientType.TO,

new InternetAddress(to));

// Set Subject: 頭字段

message.setSubject("This is the Subject Line!");

// 創建消息部分

BodyPart messageBodyPart=new MimeBodyPart();

// 消息

messageBodyPart.setText("This is message body");

// 創建多重消息

Multipart multipart=new MimeMultipart();

// 設置文本消息部分

multipart.addBodyPart(messageBodyPart);

// 附件部分

messageBodyPart=new MimeBodyPart();

String filename="file.txt";

DataSource source=new FileDataSource(filename);

messageBodyPart.setDataHandler(new DataHandler(source));

messageBodyPart.setFileName(filename);

multipart.addBodyPart(messageBodyPart);

// 發送完整消息

message.setContent(multipart );

// 發送消息

Transport.send(message);

System.out.println("Sent message successfully....");

}catch (MessagingException mex) {

mex.printStackTrace();

}

}}

編譯并運行你的程序來發送一封帶有附件的郵件。

$ java SendFileEmailSent message successfully....

用戶認證部分

如果需要提供用戶名和密碼給e-mail服務器來達到用戶認證的目的，你可以通過如下設置來完成：

props.put("mail.smtp.auth", "true");

props.setProperty("mail.user", "myuser");

props.setProperty("mail.password", "mypwd");

e-mail其他的發送機制和上述保持一致。

需要用戶名密碼驗證郵件發送實例:

本實例以QQ郵件服務器為例，你需要在登錄QQ郵箱后臺在"設置"=》賬號中開啟POP3/SMTP服務，如下圖所示：

Java 代碼如下：

// 需要用戶名密碼郵件發送實例//文件名 SendEmail2.java//本實例以QQ郵箱為例，你需要在qq后臺設置import java.util.Properties;import javax.mail.Authenticator;import javax.mail.Message;import javax.mail.MessagingException;import javax.mail.PasswordAuthentication;import javax.mail.Session;import javax.mail.Transport;import javax.mail.internet.InternetAddress;import javax.mail.internet.MimeMessage;public class SendEmail2{

public static void main(String [] args)

{

// 收件人電子郵箱

String to="xxx@qq.com";

// 發件人電子郵箱

String from="xxx@qq.com";

// 指定發送郵件的主機為 localhost

String host="smtp.qq.com"; //QQ 郵件服務器

// 獲取系統屬性

Properties properties=System.getProperties();

// 設置郵件服務器

properties.setProperty("mail.smtp.host", host);

properties.put("mail.smtp.auth", "true");

// 獲取默認session對象

Session session=Session.getDefaultInstance(properties,new Authenticator(){

public PasswordAuthentication getPasswordAuthentication()

{

return new PasswordAuthentication("xxx@qq.com", "qq郵箱密碼"); //發件人郵件用戶名、密碼

}

});

try{

// 創建默認的 MimeMessage 對象

MimeMessage message=new MimeMessage(session);

// Set From: 頭部頭字段

message.setFrom(new InternetAddress(from));

// Set To: 頭部頭字段

message.addRecipient(Message.RecipientType.TO,

new InternetAddress(to));

// Set Subject: 頭部頭字段

message.setSubject("This is the Subject Line!");

// 設置消息體

message.setText("This is actual message");

// 發送消息

Transport.send(message);

System.out.println("Sent message successfully....from w3cschool.cc");

}catch (MessagingException mex) {

mex.printStackTrace();

}

}}

如您還有不明白的可以在下面與我留言或是與我探討QQ群308855039，我們一起飛！

pring 對 Java Mail 有很好的支持。因此，Spring Boot 也提供了自動配置的支持。

Spring Boot 集成 Java Mail

Spring Boot 中使用 Java Mail 非常簡單方便。修改 pom 文件，添加依賴。

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

在 src/main/resources/application.properties 中配置郵件信息

#email
spring.mail.host=smtp.163.com
spring.mail.username=請輸入用戶名
spring.mail.password=請輸入密碼
spring.mail.port=25
spring.mail.protocol=smtp
spring.mail.default-encoding=UTF-8

單元測試

我們通過編寫單元測試用例，測試 Java Mail 是否正常工作。值得注意的是，郵件包括幾種類型：簡單文本的郵件、 HTML 文本的郵件、內嵌圖片的郵件、包含附件的郵件。

發送包含HTML文本的郵件

發送包含內嵌圖片的郵件

發送包含附件的郵件

喜歡的小伙伴，點個關注吧！

在線咨詢

上一篇：HTML選擇器和JS基礎
下一篇：技術分享 - MySQL 內部臨時表是怎么存放的

您的項目需求

*請認真填寫需求信息，我們會在24小時內與您取得聯系。

整合營銷服務商

11：SpringBoot整合JavaMail實現郵

本章目標

構建項目

測試發送郵件

總結

單元測試

您的項目需求