javaWeb开发小工具---MailUtils及其单元测试

时间:2023-03-08 22:26:19
javaWeb开发小工具---MailUtils及其单元测试

本次介绍的是,在javaWeb开发中,我们不免会遇到发送邮件的需求,比如:用户注册账号,需要激活登录,以及服务器定期向会员发送礼品信息等。所以参考有关资料,写了这个MailUtils工具类。

1.MailUtils的概述

这个MailUtils工具类底层使用了javax.mail包里面的API。所以我们要导入依赖的jar包----mail.jar和activation.jar两个jar包。

  一封邮件基本由发件人、收件人、抄送人(可选)、标题、正文、附件组成。这里我们要介绍的是邮件的发送。

在这个工具类中,主要有两个方法,

- createSession(String host,final String userName,final String passWord)

用来创建一个Session对象,参数为服务器主机,用户名,登录密码。在方法里面经过设定主机、指定邮件协议、验证登录用户、密码等,以此完成Session的创建。

- send(Session session,final Mail mail)

通过创建的Session和Mail对象,来发送邮件,Mail对象中存放发件人的邮箱和收件人的邮箱。

2.MailUtils的实现

在编写工具类过程中,我们要创建Mail邮件和AttachBean附件两个实体对象。

【代码清单--1】Mail.java

 package com.lxf.bean;

 import java.util.ArrayList;
import java.util.List; /**
* 邮件类
* 包括:发件人,收件人,抄送(可选),主题,正文,附件
* @author Administrator
*
*/
public class Mail
{
//发件人
private String from;
//收件人
private StringBuilder toAddress = new StringBuilder();
//抄送
private StringBuilder ccAddress = new StringBuilder();
//主题
private String subject;
//正文
private String content;
//附件列表
private List<AttachBean> list = new ArrayList<AttachBean>(); public Mail()
{
} public Mail(String from, String to)
{
this(from,to,null,null);
} public Mail(String from,String to,String subject,String content)
{
this.from = from;
this.toAddress.append(to);
this.subject = subject;
this.content = content;
} public String getFrom()
{
return from;
}
public void setFrom(String from)
{
this.from = from;
} public String getToAddress()
{
return toAddress.toString();
} public void ADDToAddress(String to)
{
if(this.toAddress.length() > 0)
{
toAddress.append(",");
}
this.toAddress .append(to);
} public String getCcAddress()
{
return ccAddress.toString();
}
public void addCcAddress(String cc)
{
if(this.ccAddress.length() > 0)
{
this.ccAddress.append(",");
}
this.ccAddress.append(cc);
} public String getSubject()
{
return subject;
}
public void setSubject(String subject)
{
this.subject = subject;
}
public String getContent()
{
return content;
}
public void setContent(String content)
{
this.content = content;
}
public List<AttachBean> getAttachs()
{
return list;
}
public void setList(AttachBean attachBean)
{
this.list.add(attachBean);
} }

【代码清单--2】 AttachBean.java(附件:文件序号、文件、文件名)

 package com.lxf.bean;

 import java.io.File;

 public class AttachBean
{
//序号,文件,文件名
private String cid;
private File file;
private String fileName; public AttachBean()
{
} public AttachBean(String cid, File file, String fileName)
{
super();
this.cid = cid;
this.file = file;
this.fileName = fileName;
} public String getCid()
{
return cid;
} public void setCid(String cid)
{
this.cid = cid;
} public File getFile()
{
return file;
} public void setFile(File file)
{
this.file = file;
} public String getFileName()
{
return fileName;
} public void setFileName(String fileName)
{
this.fileName = fileName;
} }

【代码清单--3】MailUtils.java 邮件工具类 ---用来发送邮件

 package com.lxf.myCommonUtils;

 import java.io.IOException;
import java.util.List;
import java.util.Properties; import javax.mail.Authenticator;
import javax.mail.Message.RecipientType;
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.MimeBodyPart;
import javax.mail.internet.MimeMessage;
import javax.mail.internet.MimeMultipart;
import javax.mail.internet.MimeUtility; import com.lxf.bean.AttachBean;
import com.lxf.bean.Mail; /**
* 邮件工具类 ---用来发送邮件
* 该工具类底层运用到了javaMail,因此需要引入两个jar包
*
* mail.jar activator.jar
* @author Administrator
*
*/
public class MailUtils
{
//创建session对象。
public static Session createSession(String host,final String userName,final String passWord)
{
Properties prop = new Properties();
//设定主机
prop.setProperty("mail.host", host);
//指定邮件协议,验证为true
prop.setProperty("mail.smtp.auth", "true"); //创建验证器
Authenticator auth = new Authenticator(){
public PasswordAuthentication getPasswordAuthenticator()
{
return new PasswordAuthentication(userName,passWord);
}
};
return Session.getInstance(prop, auth);
} public static void send(Session session,final Mail mail) throws MessagingException, MessagingException, IOException
{
//创建邮件对象
MimeMessage msg = new MimeMessage(session);
//设置发件人
msg.setFrom(new InternetAddress(mail.getFrom()));
msg.addRecipients(RecipientType.TO, mail.getToAddress()); //设置抄送
String cc = mail.getCcAddress();
if(!cc.isEmpty())
{
msg.addRecipients(RecipientType.CC, cc);
} //设置主题
msg.setSubject(mail.getSubject()); //创建部件集对象
MimeMultipart parts = new MimeMultipart(); //创建一个部件
MimeBodyPart part = new MimeBodyPart(); //设置邮件正文内容
part.setContent(mail.getContent(),"text/html;charset=utf-8");
//把部件加到部件集中
parts.addBodyPart(part); //获取所有附件
List<AttachBean> list = mail.getAttachs();
if(null != list)
{
for(AttachBean attach :list)
{
//创建一个部件
MimeBodyPart attachPart = new MimeBodyPart();
//设置附件文件
attachPart.attachFile(attach.getFile());
//设置附件文件名
attachPart.setFileName(MimeUtility.encodeText(attach.getFileName()));
String cid = attach.getCid();
if(cid != null)
{
attachPart.setContentID(cid);
}
parts.addBodyPart(attachPart);
}
}
//给邮件设置内容
msg.setContent(parts);
Transport.send(msg);
}
}

3.MailUtils的测试

这里要测试的就是邮件的正确发送,主要验证send()方法。

【代码清单--4】

 package com.lxf.test;

 import java.io.IOException;

 import javax.mail.MessagingException;
import javax.mail.Session; import org.junit.Test; import com.lxf.bean.Mail;
import com.lxf.myCommonUtils.MailUtils; /**
* 邮件测试类
* @author Administrator
*
*/
public class MailTest
{
@Test
public void testSend() throws MessagingException, IOException
{
//创建Session对象,指定主机,用户名,密码
//这里假设用163邮箱,smtp是邮件协议。
Session session = MailUtils.createSession("smtp.163.com", "这里输入邮箱@前面的信息", "邮箱密码"); //创建一个Mail对象,设置发件人和收件人
Mail mail = new Mail("你的邮箱完整信息","对方邮箱完整信息");
//设置主题
mail.setSubject("给**的100封信");
//设置正文
mail.setContent("这时第1封信");
//发送邮件
MailUtils.send(session, mail);
}
}

这里要说的是,当你在测试的话,可能会下面抛出这个异常。

javaWeb开发小工具---MailUtils及其单元测试

这时因为你的邮箱在注册的时候没有勾选开启,用代码发送邮件的协议,也就是上面的那个smtp协议,所有,我们要正确开启,才能把邮件发送出去。

这里我已QQ邮箱为例,来介绍一下怎么开启smtp协议。

1.打开你的qq邮箱,点击你的用户名,则进入【邮箱设置】界面;

javaWeb开发小工具---MailUtils及其单元测试

2.在【账户】信息栏,下拉,找到“POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服务”项。

javaWeb开发小工具---MailUtils及其单元测试

大家可以看到,SMTP服务是默认关闭的,此时我们就要申请把它打开。

最后大家在测试的话吗,邮件就会发送成功。

4.后期补充。