commons-email邮件工具类的基本使用

左手的ㄟ右手 2021-10-19 02:10 253阅读 0赞

*相关文章：*

[JavaMail-使用Java发送邮件][JavaMail-_Java]

[SpringBoot发送邮件][SpringBoot]

--------------------

## 简介： ##

commons-email是apache提供的一个开源的API，是对javamail的封装，相比之下，apache-mail 显然要好用得多，不过这两者本质上实际是一样的，apache-mail 实际上就是将 javax.mail 中那些让人烦心的邮件配置封装掉了。

## 引入jar包： ##

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> &lt;dependency&gt; &nbsp;&nbsp;&nbsp; &lt;groupId&gt;org.apache.commons&lt;/groupId&gt; &nbsp;&nbsp;&nbsp; &lt;artifactId&gt;commons-email&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp; &lt;version&gt;1.5&lt;/version&gt; &lt;/dependency&gt; </td> 
 </tr> 
 </tbody> 
</table>

以下代码分四部分：

1.发送普通文本邮件。

2.发送带附件的邮件。

3.发送内嵌图片的邮件。

## 示例： ##

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> package com.zzs.commons.mail; &nbsp; import java.net.MalformedURLException; import java.net.URL; &nbsp; import org.apache.commons.mail.DefaultAuthenticator; import org.apache.commons.mail.Email; import org.apache.commons.mail.EmailAttachment; import org.apache.commons.mail.EmailException; import org.apache.commons.mail.HtmlEmail; import org.apache.commons.mail.ImageHtmlEmail; import org.apache.commons.mail.MultiPartEmail; import org.apache.commons.mail.SimpleEmail; import org.apache.commons.mail.resolver.DataSourceUrlResolver; import org.junit.Test; &nbsp; /** &nbsp;* 使用Commons-Email发送邮件 &nbsp;*/ public class CommonsEmailTest { &nbsp;&nbsp;&nbsp; /** &nbsp;&nbsp;&nbsp; &nbsp;* 发送内容为简单文本的邮件 &nbsp;&nbsp;&nbsp; &nbsp;*/ &nbsp;&nbsp;&nbsp; @Test &nbsp;&nbsp;&nbsp; public void sendSimpleTextEmail() throws EmailException { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 发送简单的email,不能添加附件 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Email email = new SimpleEmail(); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 邮件服务器域名 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setHostName("smtp.sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 邮件服务器smtp协议的SSL端口 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSmtpPort(465); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 用户名和密码为邮箱的账号和密码 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setAuthenticator(new DefaultAuthenticator("用户名", "密码")); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // SSL安全连接 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSSLOnConnect(true); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 设置字符编码方式 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setCharset("UTF-8"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 发件人 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setFrom("xxx@sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 收件人 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.addTo("xxx@163.com"); //&nbsp;&nbsp;&nbsp;&nbsp; email.addTo(String... emails);//发送给多人 //&nbsp;&nbsp;&nbsp;&nbsp; // 抄送 //&nbsp;&nbsp;&nbsp;&nbsp; email.addCc("xxx"); //&nbsp;&nbsp;&nbsp;&nbsp; // 密送 //&nbsp;&nbsp;&nbsp;&nbsp; email.addBcc("xxx"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 邮件主题 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSubject("测试邮件"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 邮件正文 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setMsg("This is a test mail from java application. 哈哈"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 发送 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.send(); &nbsp;&nbsp;&nbsp; } &nbsp; &nbsp;&nbsp;&nbsp; /** &nbsp;&nbsp;&nbsp; &nbsp;* 发送包含附件的邮件（附件为本地资源） &nbsp;&nbsp;&nbsp; &nbsp;*/ &nbsp;&nbsp;&nbsp; @Test &nbsp;&nbsp;&nbsp; public void sendEmailsWithAttachments() throws EmailException { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 附件类，可以添加本地资源，也可以指定网络上资源，在发送时自动将网络上资源下载发送 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; EmailAttachment attachment = new EmailAttachment(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 本地路径 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attachment.setPath("E:\\test\\data\\mail\\123.jpg"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 定义附件 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attachment.setDisposition(EmailAttachment.ATTACHMENT); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 附件描述 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attachment.setDescription("Picture"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 附件名（为中文时要处理编码） &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attachment.setName("pic.jpg"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 文本邮件，可以添加多个附件 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; MultiPartEmail email = new MultiPartEmail(); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setHostName("smtp.sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setAuthentication("用户名", "密码"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setFrom("xxx@sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.addTo("xxx@163.com"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSubject("测试邮件"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setMsg("Here is a test mail."); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.attach(attachment); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.send(); &nbsp;&nbsp;&nbsp; } &nbsp; &nbsp;&nbsp;&nbsp; /** &nbsp;&nbsp;&nbsp; &nbsp;* 发送包含附件的邮件（附件为在线资源） &nbsp;&nbsp;&nbsp; &nbsp;*/ &nbsp;&nbsp;&nbsp; @Test &nbsp;&nbsp;&nbsp; public void sendEmailsWithOnlineAttachments() throws EmailException, MalformedURLException { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; EmailAttachment attachment = new EmailAttachment(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attachment.setURL(new URL("https://www.baidu.com/img/bd_logo1.png")); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attachment.setDisposition(EmailAttachment.ATTACHMENT); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attachment.setDescription("Baidu logo"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; attachment.setName("Baidu.png"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; MultiPartEmail email = new MultiPartEmail(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setHostName("smtp.sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setAuthentication("用户名", "密码"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setFrom("xxx@sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.addTo("xxx@163.com"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSubject("测试邮件"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setMsg("Here is Baidu's logo."); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.attach(attachment); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.send(); &nbsp;&nbsp;&nbsp; } &nbsp; &nbsp;&nbsp;&nbsp; /** &nbsp;&nbsp;&nbsp; &nbsp;* 发送内容为HTML格式的邮件,内嵌图片 &nbsp;&nbsp;&nbsp; &nbsp;*/ &nbsp;&nbsp;&nbsp; @Test &nbsp;&nbsp;&nbsp; public void sendHTMLFormattedEmail() throws EmailException, MalformedURLException { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // HTML格式邮件，同时具有MultiPartEmail类所有“功能” &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; HtmlEmail email = new HtmlEmail(); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setHostName("smtp.sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setAuthentication("用户名", "密码"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setFrom("xxx@sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.addTo("xxx@163.com"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSubject("测试邮件"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 图片的网络地址 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; URL url = new URL("https://www.baidu.com/img/bd_logo1.png"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; String cid = email.embed(url, "Baidu logo"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 将图片引入html标签 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setHtmlMsg("&lt;html&gt;The Baidu logo &lt;br/&gt;&lt;img src='cid:" + cid + "'&gt;&lt;/html&gt;"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.send(); &nbsp;&nbsp;&nbsp; } &nbsp; &nbsp;&nbsp;&nbsp; /** &nbsp;&nbsp;&nbsp; &nbsp;* 发送内容为HTML格式的邮件,内嵌图片 &nbsp;&nbsp;&nbsp; &nbsp;*/ &nbsp;&nbsp;&nbsp; @Test &nbsp;&nbsp;&nbsp; public void sendHTMLFormattedEmailWithEmbeddedImages() throws MalformedURLException, EmailException { &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // ImageHtmlEmail类通常是用来发送Html格式并内嵌图片的邮件，它拥有所有HtmlEmail的功能，但是图片主要是以html内嵌的为主 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ImageHtmlEmail email = new ImageHtmlEmail(); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setHostName("smtp.sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSmtpPort(456); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSSLOnConnect(true); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setAuthentication("用户名", "密码"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setFrom("xxx@sohu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.addTo("xxx@163.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setCharset("UTF-8"); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setSubject("测试邮件"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; URL url = new URL("https://www.baidu.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 这样HTML内容里如果有此路径下的图片会直接内联 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setDataSourceResolver(new DataSourceUrlResolver(url)); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; String htmlEmail = "这里&lt;img src='https://www.baidu.com/img/bd_logo1.png'&gt;有图片。"; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.setHtmlMsg(htmlEmail); &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; email.send(); &nbsp;&nbsp;&nbsp; } } </td> 
 </tr> 
 </tbody> 
</table>

[JavaMail-_Java]: https://blog.csdn.net/backbug/article/details/99559858
[SpringBoot]: https://blog.csdn.net/backbug/article/details/100636863