前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >10 分钟实现 SpringBoot 发送邮件功能

10 分钟实现 SpringBoot 发送邮件功能

作者头像
终码一生
发布2022-04-15 10:07:40
3K2
发布2022-04-15 10:07:40
举报
文章被收录于专栏:终码一生终码一生

# 什么是 SMTP?

SMTP 全称为 Simple Mail Transfer Protocol(简单邮件传输协议),它是一组用于从源地址到目的地址传输邮件的规范,通过它来控制邮件的中转方式。SMTP 认证要求必须提供账号和密码才能登陆服务器,其设计目的在于避免用户受到垃圾邮件的侵扰。

# 什么是 IMAP?

IMAP 全称为 Internet Message Access Protocol(互联网邮件访问协议),IMAP 允许从邮件服务器上获取邮件的信息、下载邮件等。IMAP 与 POP 类似,都是一种邮件获取协议。

# 什么是 POP3?

POP3 全称为 Post Office Protocol 3(邮局协议),POP3 支持客户端远程管理服务器端的邮件。POP3 常用于 “离线” 邮件处理,即允许客户端下载服务器邮件,然后服务器上的邮件将会被删除。目前很多 POP3 的邮件服务器只提供下载邮件功能,服务器本身并不删除邮件,这种属于改进版的 POP3 协议。

# IMAP 和 POP3 协议有什么不同呢?

两者最大的区别在于,IMAP 允许双向通信,即在客户端的操作会反馈到服务器上,例如在客户端收取邮件、标记已读等操作,服务器会跟着同步这些操作。而对于 POP 协议虽然也允许客户端下载服务器邮件,但是在客户端的操作并不会同步到服务器上面的,例如在客户端收取或标记已读邮件,服务器不会同步这些操作。

# 什么是JavaMailSender和JavaMailSenderImpl?

JavaMailSender和JavaMailSenderImpl 是 Spring 官方提供的集成邮件服务的接口和实现类,以简单高效的设计著称,目前是 Java 后端发送邮件和集成邮件服务的主流工具。

# 如何通过JavaMailSenderImpl发送邮件?

非常简单,直接在业务类注入JavaMailSenderImpl并调用send方法发送邮件。其中简单邮件可以通过SimpleMailMessage来发送邮件,而复杂的邮件(例如添加附件)可以借助MimeMessageHelper来构建MimeMessage发送邮件。例如:

代码语言:javascript
复制
@Autowired
private JavaMailSenderImpl mailSender;

public void sendMail() throws MessagingException {

        SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
        simpleMailMessage.setFrom("admin@163.com");
        simpleMailMessage.setTo("socks@qq.com");
        simpleMailMessage.setSubject("Happy New Year");
        simpleMailMessage.setText("新年快乐!");
        mailSender.send(simpleMailMessage);


        MimeMessage mimeMessage = mailSender.createMimeMessage();
        MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage);
        messageHelper.setFrom("admin@163.com");
        messageHelper.setTo("socks@qq.com");
        messageHelper.setSubject("Happy New Year");
        messageHelper.setText("新年快乐!");
        messageHelper.addInline("doge.gif", new File("xx/xx/doge.gif"));
        messageHelper.addAttachment("work.docx", new File("xx/xx/work.docx"));
        mailSender.send(mimeMessage);
    }
代码语言:javascript
复制
# 为什么JavaMailSenderImpl 能够开箱即用 ?

所谓开箱即用其实就是基于官方内置的自动配置,翻看源码可知晓邮件自动配置类(MailSenderPropertiesConfiguration) 为上下文提供了邮件服务实例(JavaMailSenderImpl)。具体源码如下:

代码语言:javascript
复制
@Configuration
@ConditionalOnProperty(prefix = "spring.mail", name = "host")
class MailSenderPropertiesConfiguration {
private final MailProperties properties;
    MailSenderPropertiesConfiguration(MailProperties properties) {
this.properties = properties;
    }
@Bean
@ConditionalOnMissingBean
public JavaMailSenderImpl mailSender() {
        JavaMailSenderImpl sender = new JavaMailSenderImpl();
        applyProperties(sender);
return sender;
    }
代码语言:javascript
复制

其中MailProperties是关于邮件服务器的配置信息,具体源码如下:

代码语言:javascript
复制
@ConfigurationProperties(prefix = "spring.mail")
public class MailProperties {
private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
private String host;
private Integer port;
private String username;
private String password;
private String protocol = "smtp";
private Charset defaultEncoding = DEFAULT_CHARSET;
private Map<String, String> properties = new HashMap<>();
}

# 开启邮件服务

登陆网易邮箱 163,在设置中打开并勾选POP3/SMTP/IMAP服务,然后会得到一个授权码,这个邮箱和授权码将用作登陆认证。

# 配置邮件服务

首先咱们通过 Spring Initializr 创建工程springboot-send-mail,如图所示:

然后在pom.xml 引入web、thymeleaf 和spring-boot-starter-mail等相关依赖。例如:

代码语言:javascript
复制
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>webjars-locator-core</artifactId>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>jquery</artifactId>
<version>3.3.1</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>bootstrap</artifactId>
<version>3.3.7</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
    </dependencies>

根据前面提到的配置项(MailProperties)填写相关配置信息,其中spring.mail.username 表示连接邮件服务器时认证的登陆账号,可以是普通的手机号或者登陆账号,并非一定是邮箱,为了解决这个问题,推荐大家在spring.mail. properties.from填写邮件发信人即真实邮箱。

然后在application.yml添加如下配置:

代码语言:javascript
复制
spring:
  mail:
    host: smtp.163.com #SMTP服务器地址
    username:  socks #登陆账号
    password: 123456 #登陆密码(或授权码)
    properties:
      from: socks@163.com #邮件发信人(即真实邮箱)
  thymeleaf:
cache: false
    prefix: classpath:/views/
  servlet:
    multipart:
max-file-size: 10MB #限制单个文件大小
max-request-size: 50MB #限制请求总量

透过前面的进阶知识,我们知道在发送邮件前,需要先构建 SimpleMailMessage或 MimeMessage 邮件信息类来填写邮件标题、邮件内容等信息,最后提交给JavaMailSenderImpl发送邮件,这样看起来没什么问题,也能实现既定目标,但在实际使用中会出现大量零散和重复的代码,还不便于保存邮件到数据库。

那么优雅的发送邮件应该是如何的呢?应该屏蔽掉这些构建信息和发送邮件的细节,不管是简单还是复杂邮件,都可以通过统一的 API 来发送邮件。例如:mailService.send(mailVo) 。

例如通过邮件信息类 (MailVo) 来保存发送邮件时的邮件主题、邮件内容等信息 :

代码语言:javascript
复制
package com.hehe.vo;

public class MailVo {
private String id;
private String from;
private String to;
private String subject;
private String text;
private Date sentDate;
private String cc;
private String bcc;
private String status;
private String error;
@JsonIgnore
private MultipartFile[] multipartFiles;

}

# 发送邮件和附件

=========== 接下来正式介绍发送邮件的最核心逻辑 前方高能 =============

除了发送邮件之外,还包括检测邮件和保存邮件等操作,例如:

  • 检测邮件 checkMail(); 首先校验邮件收信人、邮件主题和邮件内容这些必填项,若为空则拒绝发送。
  • 发送邮件 sendMimeMail(); 其次通过 MimeMessageHelper 来解析 MailVo 并构建 MimeMessage 传输邮件。
  • 保存邮件 sendMimeMail(); 最后将邮件保存到数据库,便于统计和追查邮件问题。

本案例邮件业务类 MailService 的具体源码如下:

代码语言:javascript
复制
package com.hehe.service;

@Service
public class MailService {

private Logger logger = LoggerFactory.getLogger(getClass());

@Autowired
private JavaMailSenderImpl mailSender;

public MailVo sendMail(MailVo mailVo) {
try {
            checkMail(mailVo); 
            sendMimeMail(mailVo); 
return saveMail(mailVo); 
        } catch (Exception e) {
            logger.error("发送邮件失败:", e);
            mailVo.setStatus("fail");
            mailVo.setError(e.getMessage());
return mailVo;
        }

    }

private void checkMail(MailVo mailVo) {
if (StringUtils.isEmpty(mailVo.getTo())) {
throw new RuntimeException("邮件收信人不能为空");
        }
if (StringUtils.isEmpty(mailVo.getSubject())) {
throw new RuntimeException("邮件主题不能为空");
        }
if (StringUtils.isEmpty(mailVo.getText())) {
throw new RuntimeException("邮件内容不能为空");
        }
    }

private void sendMimeMail(MailVo mailVo) {
try {
            MimeMessageHelper messageHelper = new MimeMessageHelper(mailSender.createMimeMessage(), true);
            mailVo.setFrom(getMailSendFrom());
            messageHelper.setFrom(mailVo.getFrom());
            messageHelper.setTo(mailVo.getTo().split(","));
            messageHelper.setSubject(mailVo.getSubject());
            messageHelper.setText(mailVo.getText());
if (!StringUtils.isEmpty(mailVo.getCc())) {
                messageHelper.setCc(mailVo.getCc().split(","));
            }
if (!StringUtils.isEmpty(mailVo.getBcc())) {
                messageHelper.setCc(mailVo.getBcc().split(","));
            }
if (mailVo.getMultipartFiles() != null) {
for (MultipartFile multipartFile : mailVo.getMultipartFiles()) {
                    messageHelper.addAttachment(multipartFile.getOriginalFilename(), multipartFile);
                }
            }
if (StringUtils.isEmpty(mailVo.getSentDate())) {
                mailVo.setSentDate(new Date());
                messageHelper.setSentDate(mailVo.getSentDate());
            }
            mailSender.send(messageHelper.getMimeMessage());
            mailVo.setStatus("ok");
            logger.info("发送邮件成功:{}->{}", mailVo.getFrom(), mailVo.getTo());
        } catch (Exception e) {
throw new RuntimeException(e);
        }
    }

private MailVo saveMail(MailVo mailVo) {

return mailVo;
    }

public String getMailSendFrom() {
return mailSender.getJavaMailProperties().getProperty("from");
    }
}

搞定了发送邮件最核心的业务逻辑,接下来咱们写一个简单页面用来发送邮件。

首先写好跟页面交互的控制器 MailController,具体源码如下:

代码语言:javascript
复制
@RestController
public class MailController {
@Autowired
private MailService mailService;

@GetMapping("/")
public ModelAndView index() {
        ModelAndView mv = new ModelAndView("mail/sendMail");
        mv.addObject("from", mailService.getMailSendFrom());
return mv;
    }

@PostMapping("/mail/send")
public MailVo sendMail(MailVo mailVo, MultipartFile[] files) {
        mailVo.setMultipartFiles(files);
return mailService.sendMail(mailVo);
    }
}

然后在/resources/views/mail目录新建sendMail.html,具体源码如下:

代码语言:javascript
复制
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">

<head>
<meta charset="UTF-8"/>
<title>发送邮件</title>
<link th:href="@{/webjars/bootstrap/css/bootstrap.min.css}" rel="stylesheet" type="text/css"/>
<script th:src="@{/webjars/jquery/jquery.min.js}"></script>
<script th:href="@{/webjars/bootstrap/js/bootstrap.min.js}"></script>

</head>

<body>
<div>
<marquee behavior="alternate" onfinish="alert(12)"
onMouseOut="this.start();$('#egg').text('嗯 真听话!');"
onMouseOver="this.stop();$('#egg').text('有本事放开我呀!');">
<h5>祝大家新年快乐!</h5><img src="http://pics.sc.chinaz.com/Files/pic/faces/3709/7.gif" alt="">
</marquee>

<form>
<div>
<label>邮件发信人:</label>
<div>
<input ${from}" readonly="readonly">
</div>
</div>
<div>
<label>邮件收信人:</label>
<div>
<input >
</div>
</div>
<div>
<label>邮件主题:</label>
<div>
<input >
</div>
</div>
<div>
<label>邮件内容:</label>
<div>
<textarea ></textarea>
</div>
</div>
<div>
<label>邮件附件:</label>
<div>
<input >
</div>
</div>
<div>
<label>邮件操作:</label>
<div>
<a onclick="sendMail()">发送邮件</a>
</div>
<div>
<a onclick="clearForm()">清空</a>
</div>
</div>
</form>

<script th:inline="javascript">
        var appCtx = [[${#request.getContextPath()}]];

        function sendMail() {

            var formData = new FormData($('#mailForm')[0]);
            $.ajax({
                url: appCtx + '/mail/send',
                type: "POST",
                data: formData,
                contentType: false,
                processData: false,
                success: function (result) {
                    alert(result.status === 'ok' ? "发送成功!" : "你被Doge嘲讽了:" + result.error);
                },
                error: function () {
                    alert("发送失败!");
                }
            });
        }

        function clearForm() {
            $('#mailForm')[0].reset();
        }

        setInterval(function () {
            var total = $('#mq').width();
            var width = $('#doge').width();
            var left = $('#doge').offset().left;
            if (left <= width / 2 + 20) {
                $('#doge').css('transform', 'rotateY(180deg)')
            }
if (left >= total - width / 2 - 40) {
                $('#doge').css('transform', 'rotateY(-360deg)')
            }
        });
</script>
</div>
</body>
</html>
代码语言:javascript
复制

# 测试发送邮件

如果是初学者,建议大家先下载源码,修改配置后运行工程,成功后再自己重新写一遍代码,这样有助于加深记忆。

启动工程并访问:http://localhost:8080 然后可以看到发送邮件的主界面如下:

然后填写你的小号邮箱,点击发送邮件,若成功则可以登陆小号邮箱查看邮件和刚才上传的附件。

至此发送邮件代码全部完成,欢迎大家下载并关注 Github 源码。

# 常见失败编码

如果企业定制了邮件服务器,自然会记录邮件日志,根据错误编码存储日志有利于日常维护。

例如这些由网易邮箱提供的错误编码标识:

  • 421   421 HL:REP 该 IP 发送行为异常,存在接收者大量不存在情况,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并核对发送列表有效性;   421 HL:ICC 该 IP 同时并发连接数过大,超过了网易的限制,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并降低 IP 并发连接数量;   421 HL:IFC 该 IP 短期内发送了大量信件,超过了网易的限制,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并降低发送频率;   421 HL:MEP 该 IP 发送行为异常,存在大量伪造发送域域名行为,被临时禁止连接。请检查是否有用户发送病毒或者垃圾邮件,并使用真实有效的域名发送;
  • 450   450 MI:CEL 发送方出现过多的错误指令。请检查发信程序;   450 MI:DMC 当前连接发送的邮件数量超出限制。请减少每次连接中投递的邮件数量;   450 MI:CCL 发送方发送超出正常的指令数量。请检查发信程序;   450 RP:DRC 当前连接发送的收件人数量超出限制。请控制每次连接投递的邮件数量;   450 RP:CCL 发送方发送超出正常的指令数量。请检查发信程序;   450 DT:RBL 发信 IP 位于一个或多个 RBL 里。请参考 http://www.rbls.org/ 关于 RBL 的相关信息;   450 WM:BLI 该 IP 不在网易允许的发送地址列表里;   450 WM:BLU 此用户不在网易允许的发信用户列表里;
  • 451   451 DT:SPM ,please try again 邮件正文带有垃圾邮件特征或发送环境缺乏规范性,被临时拒收。请保持邮件队列,两分钟后重投邮件。需调整邮件内容或优化发送环境;   451 Requested mail action not taken: too much fail authentication 登录失败次数过多,被临时禁止登录。请检查密码与帐号验证设置;   451 RP:CEL 发送方出现过多的错误指令。请检查发信程序;   451 MI:DMC 当前连接发送的邮件数量超出限制。请控制每次连接中投递的邮件数量;   451 MI:SFQ 发信人在 15 分钟内的发信数量超过限制,请控制发信频率;   451 RP:QRC 发信方短期内累计的收件人数量超过限制,该发件人被临时禁止发信。请降低该用户发信频率;   •451 Requested action aborted: local error in processing 系统暂时出现故障,请稍后再次尝试发送;
  • 500   500 Error: bad syntaxU 发送的 smtp 命令语法有误;   550 MI:NHD HELO 命令不允许为空;   550 MI:IMF 发信人电子邮件地址不合规范。请参考 http://www.rfc-editor.org/ 关于电子邮件规范的定义;   550 MI:SPF 发信 IP 未被发送域的 SPF 许可。请参考 http://www.openspf.org/ 关于 SPF 规范的定义;   550 MI:DMA 该邮件未被发信域的 DMARC 许可。请参考 http://dmarc.org/ 关于 DMARC 规范的定义;   550 MI:STC 发件人当天的连接数量超出了限定数量,当天不再接受该发件人的邮件。请控制连接次数;   550 RP:FRL 网易邮箱不开放匿名转发(Open relay);   550 RP:RCL 群发收件人数量超过了限额,请减少每封邮件的收件人数量;   550 RP:TRC 发件人当天内累计的收件人数量超过限制,当天不再接受该发件人的邮件。请降低该用户发信频率;   550 DT:SPM 邮件正文带有很多垃圾邮件特征或发送环境缺乏规范性。需调整邮件内容或优化发送环境;   550 Invalid User 请求的用户不存在;   550 User in blacklist 该用户不被允许给网易用户发信;   550 User suspended 请求的用户处于禁用或者冻结状态;   550 Requested mail action not taken: too much recipient 群发数量超过了限额;
  • 552   552 Illegal Attachment 不允许发送该类型的附件,包括以. uu .pif .scr .mim .hqx .bhx .cmd .vbs .bat .com .vbe .vb .js .wsh 等结尾的附件;   552 Requested mail action aborted: exceeded mailsize limit 发送的信件大小超过了网易邮箱允许接收的最大限制;
  • 553   553 Requested action not taken: NULL sender is not allowed 不允许发件人为空,请使用真实发件人发送;   553 Requested action not taken: Local user only SMTP 类型的机器只允许发信人是本站用户;   553 Requested action not taken: no smtp MX only MX 类型的机器不允许发信人是本站用户;   553 authentication is required SMTP 需要身份验证,请检查客户端设置;
  • 554   554 DT:SPM 发送的邮件内容包含了未被许可的信息,或被系统识别为垃圾邮件。请检查是否有用户发送病毒或者垃圾邮件;   554 DT:SUM 信封发件人和信头发件人不匹配;   554 IP is rejected, smtp auth error limit exceed 该 IP 验证失败次数过多,被临时禁止连接。请检查验证信息设置;   554 HL:IHU 发信 IP 因发送垃圾邮件或存在异常的连接行为,被暂时挂起。请检测发信 IP 在历史上的发信情况和发信程序是否存在异常;   554 HL:IPB 该 IP 不在网易允许的发送地址列表里;   554 MI:STC 发件人当天内累计邮件数量超过限制,当天不再接受该发件人的投信。请降低发信频率;   554 MI:SPB 此用户不在网易允许的发信用户列表里;   554 IP in blacklist 该 IP 不在网易允许的发送地址列表里。

# 源码下载

springboot-send-mail:https://github.com/yizhiwazi/springboot-socks

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2021-11-02,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 终码一生 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • # 什么是 IMAP?
  • # 什么是 POP3?
  • # IMAP 和 POP3 协议有什么不同呢?
  • # 什么是JavaMailSender和JavaMailSenderImpl?
  • # 如何通过JavaMailSenderImpl发送邮件?
  • # 为什么JavaMailSenderImpl 能够开箱即用 ?
  • # 开启邮件服务
  • # 配置邮件服务
  • # 发送邮件和附件
  • # 测试发送邮件
  • # 常见失败编码
相关产品与服务
多因子身份认证
多因子身份认证(Multi-factor Authentication Service,MFAS)的目的是建立一个多层次的防御体系,通过结合两种或三种认证因子(基于记忆的/基于持有物的/基于生物特征的认证因子)验证访问者的身份,使系统或资源更加安全。攻击者即使破解单一因子(如口令、人脸),应用的安全依然可以得到保障。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档