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实现邮

本章目标

构建项目

测试发送邮件

总结

单元测试

您的项目需求