项目需要做一个关于邮箱发送的需求,专门整理一下, 在这里记录
当前所用框架SpringBoot
邮箱发送我主要将它分为了三个模块
- 1.邮箱模板与配置模块
- 2.业务组装模块
- 3.核心发送组件模板
下面我们就一个个,一步步罗列叙说
1.邮箱模板与配置模块
1.1邮箱模板
顾名思义,就是我们到时候发送邮件过去后,接收到邮件的展示模板。我们以HTML格式定义模板,最后将模板发送消息过去,并展示出来。当然,我们也可以纯文本发送,不需要模板样式等这些花里胡哨的东西。不过本次我是以HTML格式为模板来进行的一次邮箱发送。
所以,前期准备第一件事,先制定好要发送模板。如下:
模板样式:
页面展示的样式:
代码:
<h3>合作类型:<span style="font-weight: normal;">#COOPERATE_TYPE#</span></h3>
<h3>姓名:<span style="font-weight: normal;">#COOPERATE_NAME#</span></h3>
<h3>城市:<span style="font-weight: normal;">#COOPERATE_CITY#</span></h3>
<h3>电话:<span style="font-weight: normal;">#COOPERATE_TELEPHONE#</span></h3>
<h3>邮箱(选填):<span style="font-weight: normal;">#COOPERATE_EMAIL#</span></h3>
<h3>提交时间:<span style="font-weight: normal;">#OCCUR_TIME#</span></h3>
<h3>请求IP:<span style="font-weight: normal;">#CLIENT_IP#</span></h3>
<h3>留言如下:</h3>
<div style="color:blue;font-size:14px;">#COOPERATE_MESSAGE#</div>
1.2邮箱配置信息
用哪个邮件服务器?端口是多少?哪个邮箱发送?哪个邮箱接收?...
这些都需要配置,所以可以创建一个config.properties文件来配置这些信息
配置示例:
代码:
#腾讯企业邮箱
mail.qq.projectName=合作申请
mail.qq.mailServerHost=smtp.exmail.qq.com
mail.qq.mailServerPort=465
mail.qq.devModel=false
mail.qq.ssl=true #腾讯企业邮箱必须SSL
mail.qq.reporterMailConfigsStr=[{"userName":"qqSend@tencent.com","password":"12345678"}]
mail.qq.receiverMailsStr=["qqReceiver@tencent.com"]
至此,我们前期相关的准备工作就OK了。
下面,我们就开始业务层
2.业务组装模块
2.1邮箱配置组装
在上面我们在config.properties内已经配置相关邮箱信息,接下来就是获取并赋予相关邮箱配置类
2.1.1,创建 配置接收类
用于接收配置文件内的参数信息
利用@ConfigurationProperties与@PropertySource注解获取到config文件内的相关参数
2.1.2,创建 邮件配置实体类
该类包含了邮件配置相关的信息
2.1.3,创建邮件发送信息实体类
该类包含了邮件相关的发送信息
2.2邮件模板组装
我们已经创建好了模板,那如何使用该模板?并将里面的参数替换为我们要发送的信息?
创建模板组装类,专门处理下面所有模板的组装
2.2.1,获取到模板内的所有信息,并转换为字符串
使用上面截图内的方法,可将模板内的信息转换为字符并返回
2.2.2,接下来就是替换参数了,
细心的朋友应该会发现,上面我在配模板时,所有的参数都用了"#参数#"的形式,如下图:
这些,就是我们要替换掉的占位符,很简单的,来搞一下
(1.)先定义一下这些占位符
(2.)再定义一下对应的参数
(3.)替换!
接收并替换发送参数,将这些参数保存到邮件发送信息类中,并返回
ok!到这里,我们一会儿要发送的邮件内容,就已经组装完毕!
等等
有些朋友可能会疑惑,这些参数内的信息是从哪来的?
赋值的呗,
什么时候?在哪赋值的?
别着急,后面会提到
2.3邮箱模板与配置整合与发送
在上面,我们已经组装好了模板与配置的相关工作。接下来,就是整合到一起,来实现最终的发送功能
创建邮件发送类,专门用来进行下面相关业务的整合
2.3.1,赋值MailConfig实体
我们有了配置文件信息,利用config获取到了配置文件的信息,紧接着就是从config内赋值给MailConfig实体
2.3.2,保存发送信息
(1.)接收到要发送的数据
(2.)创建模板组装类对象实例
(3.)将这些数据保存至模板组装类中
(4.)传递当前模板组装类到邮件发送类的发送方法
2.3.3,发送邮件
首先利用模板组装类的组装方法,获取到邮件发送信息实体
再随机获取邮件配置实体,
进行相关赋值,最后调用邮件核心发送模块,进行发送3.核心发送组件模块
3.1创建邮件发送类
构建邮件内容方法
/**
* 构建邮件内容
*/
private static Message buildHtmlMailMessage(MailConfig config, MailInfo mail) {
MailAuthenticator authenticator = null;
Properties pro = config.getProperties();
// 如果需要身份认证,则创建一个密码验证器
if (config.isValidate()) {
authenticator = new MailAuthenticator(config.getUserName(),
config.getPassword());
}
// 根据邮件会话属性和密码验证器构造一个发送邮件的session
MailSSLSocketFactory sf = null;
try {
sf = new MailSSLSocketFactory();
sf.setTrustAllHosts(true);
} catch (GeneralSecurityException e1) {
e1.printStackTrace();
}
if (config.isSsl()) {
pro.put("mail.smtp.ssl.enable", "true");
pro.put("mail.smtp.ssl.socketFactory", sf);
}
Session sendMailSession = Session.getInstance(pro, authenticator);
try {
// 根据session创建一个邮件消息
Message mailMessage = new MimeMessage(sendMailSession);
// 创建邮件发送者地址
Address from = new InternetAddress(mail.getFromAddress());
// 设置邮件消息的发送者
mailMessage.setFrom(from);
if (mail.getToAddress() != null
&& (!"".equals(mail.getToAddress().trim()))) {
// 创建邮件的接收者地址,并设置到邮件消息中
Address to = new InternetAddress(mail.getToAddress());
// Message.RecipientType.TO属性表示接收者的类型为TO
mailMessage.setRecipient(Message.RecipientType.TO, to);
}
// 设置邮件消息的主题
mailMessage.setSubject(mail.getSubject());
// 邮件优先级1为高,3为中,5为低,默认为中
mailMessage.addHeader("X-Priority",
String.valueOf(mail.getPriority()));
// 设置邮件消息发送的时间
mailMessage.setSentDate(new Date());
// MiniMultipart类是一个容器类,包含MimeBodyPart类型的对象
Multipart mainPart = new MimeMultipart();
// 创建一个包含HTML内容的MimeBodyPart
BodyPart html = new MimeBodyPart();
// 设置HTML内容
html.setContent(mail.getContent(), "text/html; charset=utf-8");
mainPart.addBodyPart(html);
// 将MiniMultipart对象设置为邮件内容
mailMessage.setContent(mainPart);
return mailMessage;
} catch (MessagingException ex) {
throw new RuntimeException(ex);
}
}
调用接口
/** * 通过mailInfo这个邮件实体类,来发送一封HTML格式的电子邮件
*/
public static boolean sendHtmlMail(MailConfig config, MailInfo mail) {
try {
// 发送邮件
Message msg = buildHtmlMailMessage(config, mail);
Transport.send(msg);
return true;
} catch (MessagingException ex) {
throw new RuntimeException(ex);
}
}
邮件核心发送组件内包含了,多种HTML格式,文本格式,TXT格式,对多个邮箱发送相同内容的邮件...等,就不一一列举,具体代码,已上传,有需要可直接下载。
如有不对/疑惑,请留言交流