前言

邮件功能在当前互联网应用中已经是很成熟的功能，也是作为java程序员应该掌握的技能。常见使用场景有：

电商软件开电子发票，需要发到用户邮箱里面
生产实时报警，需要发到邮箱里面
银行软件申请的征信报告，电子账单流水，需要发到邮箱里面

在这里插入图片描述

1. 前置准备

确定发邮件发送人的邮箱地址，然后基于不同的邮件服务器申请授权码
有些云服务器会对邮箱端口做拦截，会出现本地能发邮件，测试环境发邮件报错，此时考虑切换465端口
当前主流邮件服务器有QQ和163，当然也有每家公司自己的邮件服务器
后续测试案例，统一以QQ邮箱为例，发送邮件

2. javax.mail

2.1 介绍

javax.mail是Sun发布的用来处理email的API。它可以方便地执行一些常用的邮件传输。 JavaMail是可选包。

2.2 pom依赖引入

<dependency><groupId>javax.mail</groupId><artifactId>mail</artifactId><version>1.4</version>
</dependency>
<dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.9</version>
</dependency>

2.3 工具类

public class MailUtils {private String smtpHost; // 邮件服务器地址private String sendUserName; // 发件人的用户名private String sendUserPass; // 发件人密码private MimeMessage mimeMsg; // 邮件对象private Multipart mp;// 附件添加的组件private void init() {// 创建一个密码验证器Authentication authenticator = null;authenticator = new Authentication(sendUserName, sendUserPass);// 实例化Properties对象Properties props = System.getProperties();props.put("mail.smtp.host", smtpHost);props.put("mail.smtp.auth", "true"); // 需要身份验证props.put("mail.smtp.starttls.enable", "true");// 建立会话Session session = Session.getDefaultInstance(props, authenticator);// 置true可以在控制台（console)上看到发送邮件的过程session.setDebug(true);// 用session对象来创建并初始化邮件对象mimeMsg = new MimeMessage(session);// 生成附件组件的实例mp = new MimeMultipart();}private MailUtils(String smtpHost, String sendUserName, String sendUserPass, String to, String cc, String mailSubject,String mailBody, List<String> attachments) {this.smtpHost = smtpHost;this.sendUserName = sendUserName;this.sendUserPass = sendUserPass;init();setFrom(sendUserName);setTo(to);setCC(cc);setBody(mailBody);setSubject(mailSubject);if (attachments != null) {for (String attachment : attachments) {addFileAffix(attachment);}}}/*** 邮件实体** @param smtpHost     邮件服务器地址* @param sendUserName 发件邮件地址* @param sendUserPass 发件邮箱密码* @param to           收件人，多个邮箱地址以半角逗号分隔* @param cc           抄送，多个邮箱地址以半角逗号分隔* @param mailSubject  邮件主题* @param mailBody     邮件正文* @param attachments  附件路径* @return*/public static MailUtils entity(String smtpHost, String sendUserName, String sendUserPass, String to, String cc,String mailSubject, String mailBody, List<String> attachments) {return new MailUtils(smtpHost, sendUserName, sendUserPass, to, cc, mailSubject, mailBody, attachments);}/*** 设置邮件主题** @param mailSubject* @return*/private boolean setSubject(String mailSubject) {try {mimeMsg.setSubject(mailSubject);} catch (Exception e) {return false;}return true;}/*** 设置邮件内容,并设置其为文本格式或HTML文件格式，编码方式为UTF-8** @param mailBody* @return*/private boolean setBody(String mailBody) {try {BodyPart bp = new MimeBodyPart();bp.setContent("<meta http-equiv=Content-Type content=text/html; charset=UTF-8>" + mailBody,"text/html;charset=UTF-8");// 在组件上添加邮件文本mp.addBodyPart(bp);} catch (Exception e) {System.err.println("设置邮件正文时发生错误！" + e);return false;}return true;}/*** 添加一个附件** @param filename 邮件附件的地址，只能是本机地址而不能是网络地址，否则抛出异常* @return*/public boolean addFileAffix(String filename) {try {if (filename != null && filename.length() > 0) {BodyPart bp = new MimeBodyPart();FileDataSource fileds = new FileDataSource(filename);bp.setDataHandler(new DataHandler(fileds));bp.setFileName(MimeUtility.encodeText(fileds.getName(), "utf-8", null)); // 解决附件名称乱码mp.addBodyPart(bp);// 添加附件}} catch (Exception e) {System.err.println("增加邮件附件：" + filename + "发生错误！" + e);return false;}return true;}/*** 设置发件人地址** @param from 发件人地址* @return*/private boolean setFrom(String from) {try {mimeMsg.setFrom(new InternetAddress(from));} catch (Exception e) {return false;}return true;}/*** 设置收件人地址** @param to 收件人的地址* @return*/private boolean setTo(String to) {if (to == null)return false;try {mimeMsg.setRecipients(Message.RecipientType.TO, InternetAddress.parse(to));} catch (Exception e) {return false;}return true;}/*** 设置抄送** @param cc* @return*/private boolean setCC(String cc) {if (cc == null) {return false;}try {mimeMsg.setRecipients(Message.RecipientType.CC, InternetAddress.parse(cc));} catch (Exception e) {return false;}return true;}/*** no object DCH for MIME type multipart/mixed报错解决*/private void solveError() {MailcapCommandMap mc = (MailcapCommandMap) CommandMap.getDefaultCommandMap();mc.addMailcap("text/html;; x-java-content-handler=com.sun.mail.handlers.text_html");mc.addMailcap("text/xml;; x-java-content-handler=com.sun.mail.handlers.text_xml");mc.addMailcap("text/plain;; x-java-content-handler=com.sun.mail.handlers.text_plain");mc.addMailcap("multipart/*;; x-java-content-handler=com.sun.mail.handlers.multipart_mixed; x-java-fallback-entry=true");mc.addMailcap("message/rfc822;; x-java-content-handler=com.sun.mail.handlers.message_rfc822");CommandMap.setDefaultCommandMap(mc);Thread.currentThread().setContextClassLoader(MailUtils.class.getClassLoader());}/*** 发送邮件** @return*/public boolean send() throws Exception {mimeMsg.setContent(mp);mimeMsg.saveChanges();System.out.println("正在发送邮件....");solveError();Transport.send(mimeMsg);System.out.println("发送邮件成功！");return true;}
}

2.4 测试类

public class TestMail {@Testpublic void testSend() throws Exception {//QQ邮箱测试String userName = "xxx@qq.com"; // 发件人邮箱String password = "rlhcuxponcichbf"; // 发件人密码，其实不一定是邮箱的登录密码，对于QQ邮箱来说是SMTP服务的授权文本String smtpHost = "smtp.qq.com"; // 邮件服务器//163邮箱测试
//         String userName = "xxxxxxx@163.com"; // 发件人邮箱
//         String password = "wdedwe"; // 发件人密码，其实不一定是邮箱的登录密码，对于QQ邮箱来说是SMTP服务的授权文本
//         String smtpHost = "smtp.163.com"; // 邮件服务器String to = "xxx@qq.com"; // 收件人，多个收件人以半角逗号分隔String cc = "xxx@qq.com"; // 抄送，多个抄送以半角逗号分隔String subject = "这是邮件的主题 163"; // 主题String body = "这是邮件的正文163"; // 正文，可以用html格式List<String> attachments = Arrays.asList("E:\\weixinData\\WeChat Files\\wxid_gv8xbkloz0wc22\\FileStorage\\File\\2023-03\\test\\src\\main\\resources\\书籍统计表.xls", "E:\\weixinData\\WeChat Files\\wxid_gv8xbkloz0wc22\\FileStorage\\File\\2023-03\\test\\src\\main\\resources\\书籍统计表.xls"); // 附件的路径，多个附件也不怕MailUtils emailUtils = MailUtils.entity(smtpHost, userName, password, to, cc, subject, body, attachments);emailUtils.send();// 发送！}
}

收到邮件
在这里插入图片描述

2. Apache Commons Email

2.1 介绍

commons-email是apache提供的一个开源的API，是对javamail的封装。主要包括：SimpleEmail,MultiPartEmail,HtmlEmail,EmailAttachment四个类。

SimpleEmail:发送简单的email,不能添加附件
MultiPartEmail:文本邮件，可以添加多个附件
HtmlEmail:HTML格式邮件，同时具有MultiPartEmail类所有“功能”
EmailAttchment:附件类，可以添加本地资源，也可以指定网络上资源，在发送时自动将网络上资源下载发送。

2.2 pom依赖引入

<dependency><groupId>org.apache.commons</groupId><artifactId>commons-email</artifactId><version>1.5</version>
</dependency>

2.3 工具类

package com.wanlong.mail.javax;import org.apache.commons.mail.DefaultAuthenticator;
import org.apache.commons.mail.EmailAttachment;
import org.apache.commons.mail.ImageHtmlEmail;
import org.springframework.util.CollectionUtils;import java.net.URL;
import java.util.List;/*** @author wanlong* @version 1.0* @description:* @date 2023/4/24 13:44*/
public class MailUtil {/*** @param smtpHost:     邮件服务器地址* @param sendUserName: 发件人邮箱地址* @param sendUserPass: 发件人邮箱授权码* @param mailSubject:  邮件主题* @param mailBody:     邮件正文* @param attachments:  附件文件地址* @param ccList:       抄送收件人列表* @param bccList:      加密收件人列表* @param to:           收件人列表，可以一个，可以多个* @return void* @Description:发送邮件* @Author: wanlong* @Date: 2023/4/24 14:59**/public static void sendMail(String smtpHost, String sendUserName, String sendUserPass, String mailSubject,String mailBody, List<String> attachments, List<String> ccList,List<String> bccList, String... to) throws Exception {//创建邮件对象ImageHtmlEmail email = new ImageHtmlEmail();// 邮件服务器域名email.setHostName(smtpHost);// 邮件服务器smtp协议的SSL端口 这里正常默认是25端口，有的云服务器默认会禁止25端口，可以替换为465email.setSmtpPort(465);// 用户名和密码为邮箱的账号和密码email.setAuthenticator(new DefaultAuthenticator(sendUserName, sendUserPass));// SSL安全连接email.setSSLOnConnect(true);// 设置字符编码方式email.setCharset("UTF-8");// 发件人email.setFrom(sendUserName);// 收件人,可以发送给多人email.addTo(to);// 抄送if (!CollectionUtils.isEmpty(ccList)) {for (String cc : ccList) {email.addCc(cc);}}// 密送if (!CollectionUtils.isEmpty(bccList)) {for (String bcc : bccList) {email.addBcc(bcc);}}// 邮件主题email.setSubject(mailSubject);// 邮件正文email.setMsg(mailBody);//附件if (!CollectionUtils.isEmpty(attachments)) {for (String path : attachments) {// 附件类，可以添加本地资源，也可以指定网络上资源，在发送时自动将网络上资源下载发送EmailAttachment attachment = new EmailAttachment();//这里判断不一定严谨，只是单纯根据地址还是路径判断的，可以方法区分参数，分别遍历添加if (path.startsWith("http")) {//附件为网上资源attachment.setURL(new URL(path));} else {// 本地路径attachment.setPath(path);}// 定义附件attachment.setDisposition(EmailAttachment.ATTACHMENT);//添加附件email.attach(attachment);}}// 发送String send = email.send();}
}

2.4 测试类

@Test
public void testSendApache() throws Exception {String userName = "qwe@qq.com"; // 发件人邮箱String password = "rlhcuxponcichbf"; // 发件人密码，其实不一定是邮箱的登录密码，对于QQ邮箱来说是SMTP服务的授权文本String smtpHost = "smtp.qq.com"; // 邮件服务器String to = "xxx@newhope.cn"; // 收件人，多个收件人以半角逗号分隔String cc = "xxx@newhope.cn"; // 抄送，多个抄送以半角逗号分隔String subject = "这是邮件的主题 163"; // 主题String body = "这是邮件的正文163"; // 正文，可以用html格式List<String> ccList = Arrays.asList(cc);List<String> pathList = Arrays.asList("E:\\weixinData\\WeChat Files\\wxid_gv8xbkloz0wc22\\FileStorage\\File\\2023-03\\test\\src\\main\\resources\\书籍统计表.xls", "E:\\weixinData\\WeChat Files\\wxid_gv8xbkloz0wc22\\FileStorage\\File\\2023-03\\test\\src\\main\\resources\\书籍统计表.xls");List<String> bccList = new ArrayList<>();MailUtil.sendMail(smtpHost,userName,password,subject,body,pathList,ccList,bccList,to);
}

正常接收邮件：
在这里插入图片描述

3.springboot结合

3.1 介绍

springboot 提供了简洁，方便的调用方式，如果项目本身是springboot，强烈推荐使用这种实现邮箱功能

3.2 pom坐标引入

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.3.RELEASE</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.example</groupId><artifactId>demo</artifactId><version>0.0.1-SNAPSHOT</version><name>demo</name><description>Demo project for Spring Boot</description><properties><java.version>8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- Spring Boot 邮件依赖 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-mail</artifactId></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build>
</project>

3.3 使用

3.3.1 yml配置邮箱信息

server:port: 8081
spring:mail:host: smtp.qq.com#默认端口号465port: 465username: xxx@qq.compassword: rlhcuxponcichbfprotocol: smtptest-connection: truedefault-encoding: UTF-8properties:mail.smtp.auth: truemail.smtp.starttls.enable: truemail.smtp.starttls.required: truemail.smtp.ssl.enable: truemail.display.sendmail: spring-boot-demo

3.3.2 创建service

package com.wanlong.learn;import javax.mail.MessagingException;public interface MailService {/*** 发送文本邮件** @param to      收件人地址* @param subject 邮件主题* @param content 邮件内容* @param cc      抄送地址*/void sendSimpleMail(String to, String subject, String content, String... cc);/*** 发送HTML邮件** @param to      收件人地址* @param subject 邮件主题* @param content 邮件内容* @param cc      抄送地址* @throws MessagingException 邮件发送异常*/void sendHtmlMail(String to, String subject, String content, String... cc) throws MessagingException;/*** 发送带附件的邮件** @param to       收件人地址* @param subject  邮件主题* @param content  邮件内容* @param filePath 附件地址* @param cc       抄送地址* @throws MessagingException 邮件发送异常*/void sendAttachmentsMail(String to, String subject, String content, String filePath, String... cc) throws MessagingException;/*** 发送正文中有静态资源的邮件** @param to      收件人地址* @param subject 邮件主题* @param content 邮件内容* @param rscPath 静态资源地址* @param rscId   静态资源id* @param cc      抄送地址* @throws MessagingException 邮件发送异常*/void sendResourceMail(String to, String subject, String content, String rscPath, String rscId, String... cc) throws MessagingException;
}

3.3.3 创建实现类

@Service
public class MailServiceImpl implements MailService {@Autowiredprivate JavaMailSender mailSender;@Value("${spring.mail.username}")private String from;/*** 发送文本邮件** @param to      收件人地址* @param subject 邮件主题* @param content 邮件内容* @param cc      抄送地址*/@Overridepublic void sendSimpleMail(String to, String subject, String content, String... cc) {SimpleMailMessage message = new SimpleMailMessage();message.setFrom(from);message.setTo(to);message.setSubject(subject);message.setText(content);if (!StringUtils.isEmpty(cc)) {message.setCc(cc);}mailSender.send(message);}/*** 发送HTML邮件** @param to      收件人地址* @param subject 邮件主题* @param content 邮件内容* @param cc      抄送地址* @throws MessagingException 邮件发送异常*/@Overridepublic void sendHtmlMail(String to, String subject, String content, String... cc) throws MessagingException {MimeMessage message = mailSender.createMimeMessage();MimeMessageHelper helper = new MimeMessageHelper(message, true);helper.setFrom(from);helper.setTo(to);helper.setSubject(subject);helper.setText(content, true);if (!StringUtils.isEmpty(cc)) {helper.setCc(cc);}mailSender.send(message);}/*** 发送带附件的邮件** @param to       收件人地址* @param subject  邮件主题* @param content  邮件内容* @param filePath 附件地址* @param cc       抄送地址* @throws MessagingException 邮件发送异常*/@Overridepublic void sendAttachmentsMail(String to, String subject, String content, String filePath, String... cc) throws MessagingException {MimeMessage message = mailSender.createMimeMessage();MimeMessageHelper helper = new MimeMessageHelper(message, true);helper.setFrom(from);helper.setTo(to);helper.setSubject(subject);helper.setText(content, true);if (!StringUtils.isEmpty(cc)) {helper.setCc(cc);}FileSystemResource file = new FileSystemResource(new File(filePath));String fileName = filePath.substring(filePath.lastIndexOf(File.separator));helper.addAttachment(fileName, file);mailSender.send(message);}/*** 发送正文中有静态资源的邮件** @param to      收件人地址* @param subject 邮件主题* @param content 邮件内容* @param rscPath 静态资源地址* @param rscId   静态资源id* @param cc      抄送地址* @throws MessagingException 邮件发送异常*/@Overridepublic void sendResourceMail(String to, String subject, String content, String rscPath, String rscId, String... cc) throws MessagingException {MimeMessage message = mailSender.createMimeMessage();MimeMessageHelper helper = new MimeMessageHelper(message, true);helper.setFrom(from);helper.setTo(to);helper.setSubject(subject);helper.setText(content, true);if (!StringUtils.isEmpty(cc)) {helper.setCc(cc);}FileSystemResource res = new FileSystemResource(new File(rscPath));helper.addInline(rscId, res);mailSender.send(message);}
}

3.3.4 注入service调用

@Controller
public class EmailController {@Autowiredprivate MailService mailService;/*** 测试发送简单邮件*/@GetMapping("/sendEmail")@ResponseBodypublic String sendSimpleMail() {mailService.sendSimpleMail("xxx@xx.xx", "这是一封简单邮件", "这是一封普通的SpringBoot测试邮件");return "ok";}
}

接收方正常收到邮件：
在这里插入图片描述

注意事项：

邮件服务器默认端口是25，有些云服务器会禁用25，此时发送邮件会发不出去，可以调整端口为465
邮件内容可以通过html展示，如果内容不复杂，可以自己手动拼接html报文格式，直接写入正文
如果邮件正文想标准化，但是报文格式又很复杂，此时不适宜通过手动拼接html展示，可以调用模板引擎 thymeleaf 生成。关键信息参数化，到时候基于每个邮件，生成定制化的文本
上面的工具类只是参考，因为发件人地址，邮箱服务器，授权码，是长期不会变又比较重要的信息，可以放到配置文件中，应用启动读取配置文件获取
邮箱一般是通用功能，可以考虑封装统一方法，封装到公司底层框架，其他人使用只要通过调用微服务或者调用本地方法一样，不需要考虑具体实现细节。
因为邮箱要访问外网，一般放在公司网关层实现