基于JavaMail开发邮件发送器工具类

在开发当中肯定会碰到利用Java调用邮件服务器的服务发送邮件的情况,比如账号激活、找回密码等功能。本人之前也碰到多次这样需求,为此特意将功能封装成一个简单易用工具类,需要用邮件发送功能时,只需要调用相关的接口即可。本人也将该工具提交到了GitHub上(https://github.com/lzj09/mail-helper),供大家参考。接下来,简单介绍一下该工具类及使用方法。

1、工程依赖

本工程主要依赖如下Jar:

<dependency>
    <groupId>javax.mail</groupId>
    <artifactId>javax.mail-api</artifactId>
    <version>1.6.2</version>
</dependency>

<dependency>
    <groupId>com.sun.mail</groupId>
    <artifactId>javax.mail</artifactId>
    <version>1.6.2</version>
</dependency>

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.23</version>
</dependency>

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

由于邮件发送是基于JavaMail的所以需要依赖JavaMail相关的Jar;

发送邮件的模板不仅支持简单的文本内容,也支持html,同时邮件模板中的语法支持freemarker语法,所以需要freemarker相关Jar;

记录日志信息,目前使用log4j。

2、核心类MailHelper

核心类MailHelper中最重要的send方法,即邮件发送方法,该方法的签名为:

public static void send(SenderConfig sender, String receiver, String subject, String template, Map<String, Object> data) throws Exception

该方法有5个参数,分别是:

  • SenderConfig sender:邮件发送账号的配置信息,配置信息有:

    // 用户名
    private String username;
    // 密码
    private String password;
    // 昵称
    private String nickname;
    // smtp服务主机名
    private String smtpHost;
    // smtp服务端口
    private String smtpPort;
    // 是否开启ssl
    private boolean isSsl;
    

    其实最主要就是smtp的配置信息

  • String receiver:邮件接收者邮箱地址

  • String subject:邮件的主题,也即在邮件列表上显示的名称

  • String template:邮件模板内容,支持freemarker语法

  • Map<String, Object> data:邮件模板中需要替换的数据内容

该方法的实现为:

// 将SenderConfig配置信息转换成Properties
Properties prop = wrapProperties(sender);

// 获取权限配置
AuthConfig auth = getAuthConfig(sender);

// 构建邮件会话
Session mailSession = Session.getDefaultInstance(prop, auth);  
mailSession.setDebug(false); 

// 构建邮件消息
Message mailMessage = new MimeMessage(mailSession);

// 设置昵称
String nick = MimeUtility.encodeText(getNickname(sender));
Address from = new InternetAddress(nick + " <" + sender.getUsername() + ">"); 
mailMessage.setFrom(from);

// 设置邮件接收者
Address to = new InternetAddress(receiver);
mailMessage.setRecipient(Message.RecipientType.TO, to);  

// 设置邮件主题
mailMessage.setSubject(subject);

// 设置发送时间
mailMessage.setSentDate(new Date());

// 设置邮件内容
Multipart mainPart = new MimeMultipart();
// 内容是可以包含html
BodyPart html = new MimeBodyPart();
html.setContent(getContent(template, data), "text/html; charset=utf-8");
mainPart.addBodyPart(html);
mailMessage.setContent(mainPart);

// 发送邮件  
Transport.send(mailMessage);

3、测试

利用邮件发送的工具类测试将邮件发送出去:

首先准备需要发送的邮件模板:test.html

<!doctype html>
<html>
    <head>
        <title>测试邮件</title>
        <meta charset="utf-8">
    </head>
    
    <body>
        <h2>${name}</h2>
        <div>${description}</div>
    </body>
</html>

其中模板中放置了2个占位符,分别是{name}和{description}

构建测试例子:

// 配置邮件发送信息
SenderConfig sender = new SenderConfig();
sender.setNickname("架构与我");
// 改成自己的邮件帐号
sender.setUsername("xxx@163.com");
// 改成自己的邮件密码
sender.setPassword("xxx");
sender.setSmtpHost("smtp.163.com");
sender.setSmtpPort("25");
sender.setSsl(false);

// 获取邮件模板
File tpl = new File("src/test/resources/test.html");
StringBuilder builder = new StringBuilder();
try (BufferedReader reader = new BufferedReader(new InputStreamReader(new FileInputStream(tpl), "utf-8"));) {
    String line = null;
    while ((line = reader.readLine()) != null) {
        builder.append(line);
    }
}

// 测试数据
Map<String, Object> data = new HashMap<String, Object>();
data.put("name", "架构与我");
data.put("description", "专注大数据、微服务架构、高并发高吞吐量大型网站、移动开发。");

// 测试发送邮件
// 改成自己的接收邮件地址
MailHelper.send(sender, "xxx@qq.com", "来自架构与我的邮件", builder.toString(), data);

发送成功后,可以看到接收邮箱的内容如下:

001.png

该邮件昵称和主题都是按我们的设置显示出来了,打开邮件内容如下:

002.png

可以看到模板当中占位符内容也替换成了我们设置的数据。

关注我

以你最方便的方式关注我:
微信公众号:


qrcode_for_gh_f65824dabadc_344.jpg
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容

  • 本文包括:1、名词解释2、邮件收发过程3、JavaMail 知识概要4、发送一封符合 MIME 协议的 JavaM...
    廖少少阅读 4,002评论 2 13
  • 早上晨读《爱叛逆》的下篇:实践篇的篇首和阿拉的“你无法讨好每一个人”,读完发现阿拉的这一小节很完美的诠释了我们与孩...
    云飞月阅读 144评论 0 2
  • 星期五的惰性来得会强一点(捂脸)思维导图 First of all PART1 向量 1,学会赋值 2、提取 PA...
    车车_8db7阅读 175评论 0 0
  • 两个男孩在教室里发生了冲突,动起了手,正好被查晚读的班主任看见,在教室后面班主任询问他们两事情的原委,进行...
    龙语阅读 546评论 0 0
  • 首先说一下异步编程: 传统的同步编程是一种请求响应模型,调用一个方法,等待其响应返回.;异步编程就是要重新考虑是否...
    有幸的风阅读 269评论 0 3