flask-mail异步发送邮件_spring Boot手把手教学(6)：发送邮件

• 1、前言
• 2、安装依赖
• 3、添加配置信息
• 4、代码实现
• 5、功能扩展
  • 5.1、发送HTML格式邮件
  • 5.2、发送带附件的邮件
  • 5.3、使用`thymeleaf`模板发送邮件

• 6、完整代码

1、前言

发送邮件应该是常用功能之一，无论是注册激活用户、账户会员到期提醒，还是业务营销信息提示，系统都需要自动向用户发邮件；

那么Spring Boot怎么发邮件呢？

Spring 推出了 JavaMailSender 简化了邮件发送的过程，现在 Spring Boot又对此进行了封装。

那就是 spring-boot-starter-mail 这个依赖包。

2、安装依赖

<!-- 邮件 --> <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-mail</artifactId> </dependency>

3、添加配置信息

❝ src/main/resources/application.yml
❞server:port: 9002spring:mail:host: smtp.qq.comusername: 149807666@qq.compassword: sputxytreefvxrgoihefresources:static-locations: classpath:/resources/, classpath:/static/ ,classpath:/templates/mail:fromMail:addr: alex@qq.com # 发邮件者# 日志级别 logging:level:root: warncom.scaffold.test.mapper: tracecom.scaffold.test.task: trace

我们这里以QQ邮箱为例，smtp.qq.com 是邮箱服务器地址；

username 就是你的邮箱地址，password 就是你的邮箱密码；

mai.fromMail.addr 就是发邮件人的邮箱地址。

4、代码实现

❝ Entity---邮件信息实体类：com.scaffold.test.entity.Mail
❞package com.scaffold.test.entity;import lombok.Data;@Data public class Mail {// 发送给谁private String to;// 发送主题private String subject;// 发送内容private String content;// 附件地址private String filePath; }❝ Service---邮件服务接口：com.scaffold.test.service.MailService
❞package com.scaffold.test.service;import com.scaffold.test.entity.Mail;public interface MailService {// 发送邮件public void sendMail(Mail mail); }❝ ServiceImpl---邮件服务接口实现类：com.scaffold.test.service.impl.MailServiceImpl
❞package com.scaffold.test.service.impl;import com.scaffold.test.entity.Mail; import com.scaffold.test.service.MailService; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.core.io.FileSystemResource; import org.springframework.mail.SimpleMailMessage; import org.springframework.mail.javamail.JavaMailSender; import org.springframework.mail.javamail.MimeMessageHelper; import org.springframework.stereotype.Service;import javax.mail.internet.MimeMessage; import java.io.File;@Service public class MailServiceImpl implements MailService {Logger logger = LoggerFactory.getLogger(this.getClass());@Autowiredprivate JavaMailSender mailSender;@Value("${mail.fromMail.addr}")private String mailFrom;// 只发送文本@Overridepublic void sendMail(Mail mail) {SimpleMailMessage message = new SimpleMailMessage();message.setFrom(mailFrom);message.setTo(mail.getTo());message.setSubject(mail.getSubject());message.setText(mail.getContent());mailSender.send(message);logger.info("发送完毕");}} ❝ Controller---发邮件控制器：com.scaffold.test.controller.MailController
❞package com.scaffold.test.controller;import com.scaffold.test.base.Result; import com.scaffold.test.base.ResultGenerator; import com.scaffold.test.entity.Mail; import com.scaffold.test.service.MailService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.scheduling.annotation.Async; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import org.thymeleaf.TemplateEngine; import org.thymeleaf.context.Context;import javax.mail.MessagingException;@RestController @RequestMapping("/mail") public class MailController {@Autowiredprivate MailService mailService;// 发送不带格式的文本@Async@GetMapping("post")public Result postMail() {Mail mail = new Mail();mail.setTo("******@qq.com");mail.setSubject("automatic");mail.setContent("自动邮件发布");mailService.sendMail(mail);return ResultGenerator.getSuccessResult().setMessage("发送成功");} }

需要注意的一点就是：我们这里的代码都是用了@Async注解，代表这是异步操作，所以返回的Result也会无效了，无效代码我就不再注释了，原来写的时候写的是同步执行。

其实这里，用异步是对的，业务代码中，邮件发送不是业务关注的重点，可以延迟或者失败，所以没必要占用主进程；

结果如图：

到此为止，简单的发送邮件功能完成了，如果要自动发布，就要加入定时任务了，可以参考上一篇文章：

spring Boot手把手教学（5）: 定时任务

这里就不再赘述；

5、功能扩展

5.1、发送HTML格式邮件

发送纯文本，有时候不是那么满足我们的业务要求，我们需要发送带HTML格式的邮件如下：

❝ 在 MailService 中添加 sendHtmlMail 方法：com.scaffold.test.service.MailService
❞package com.scaffold.test.service;import com.scaffold.test.entity.Mail;import javax.mail.MessagingException;public interface MailService {// 发送邮件public void sendMail(Mail mail);// 发送Html邮件public void sendHtmlMail(Mail mail) throws MessagingException;} ❝ 对应实现方法：com.scaffold.test.service.impl.MailServiceImpl
❞// 发送Html邮件@Overridepublic void sendHtmlMail(Mail mail) {MimeMessage message = mailSender.createMimeMessage();try {MimeMessageHelper helper = new MimeMessageHelper(message, true);message.setFrom(mailFrom);helper.setTo(mail.getTo());helper.setSubject(mail.getSubject());helper.setText(mail.getContent(), true);mailSender.send(message);logger.info("发送Html邮件成功");} catch (Exception e) {e.printStackTrace();logger.error("发送Html邮件失败");}} ❝ 控制器调用：com.scaffold.test.controller.MailController
❞// 发送Html邮件@Async@GetMapping("postHtml")public Result postHtmlMail() throws MessagingException {String content = "<html>n" +"<body>n" +"<h3>hello! test Html test!</h3>n" +"</body>n" +"</html>";Mail mail = new Mail();mail.setTo("******@qq.com");mail.setSubject("Html格式邮件");mail.setContent(content);mailService.sendHtmlMail(mail);return ResultGenerator.getSuccessResult().setMessage("发送成功");}

结果如图：

5.2、发送带附件的邮件

有时候我们需要发送带附件的邮件；

❝ 在 MailService 中添加 sendAttachmentsMail 方法：com.scaffold.test.service.MailService
❞package com.scaffold.test.service;import com.scaffold.test.entity.Mail;import javax.mail.MessagingException;public interface MailService {// 发送邮件public void sendMail(Mail mail);// 发送Html邮件public void sendHtmlMail(Mail mail) throws MessagingException;// 发送带附件的邮件public void sendAttachmentsMail(Mail mail) throws MessagingException; }❝ 对应实现类方法：com.scaffold.test.service.impl.MailServiceImpl
❞// 发送带附件的邮件@Overridepublic void sendAttachmentsMail(Mail mail) {MimeMessage message = mailSender.createMimeMessage();try {MimeMessageHelper helper = new MimeMessageHelper(message, true);message.setFrom(mailFrom);helper.setTo(mail.getTo());helper.setSubject(mail.getSubject());helper.setText(mail.getContent(), true);// 附件FileSystemResource resourse = new FileSystemResource(new File(mail.getFilePath()));// 添加附件helper.addAttachment("test.png", resourse);mailSender.send(message);logger.info("发送邮件成功");} catch (Exception e) {e.printStackTrace();logger.error("发送邮件失败");}} ❝ 控制器调用：com.scaffold.test.controller.MailController
❞// 发送带附件的邮件@Async@GetMapping("postAttachment")public Result postAttachmentsMail() throws MessagingException {Mail mail = new Mail();mail.setTo("***@qq.com");mail.setSubject("附件");mail.setContent("有附件，赶紧看下");mail.setFilePath("E:test.png");mailService.sendAttachmentsMail(mail);return ResultGenerator.getSuccessResult().setMessage("发送成功");}

效果如图：

5.3、使用thymeleaf模板发送邮件

另外，为了格式的优美，有时候我们需要使用模板发送邮件；

这里我们使用thymeleaf ：

❝ 安装依赖
❞<!-- thymeleaf 模板 --> <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency><dependency><groupId>ognl</groupId><artifactId>ognl</artifactId><version>3.2.14</version> </dpendency> ❝ 控制器调用：com.scaffold.test.controller.MailController
❞ @Autowiredprivate SpringTemplateEngine templateEngine;// 发送 Html 模板邮件@Async@GetMapping("postTemplate")public void postTemplateMail() throws MessagingException {Context context = new Context();Map<String, Object> emailParam = new HashMap<>();emailParam.put("name", "产品终端更换名字");emailParam.put("content", "牛牛终端");emailParam.put("person", "Alex Wong");context.setVariable("emailParam", emailParam);String emailTemplate = templateEngine.process("emailTemplate", context);Mail mail = new Mail();mail.setTo("*****@qq.com");mail.setSubject("模板邮件");mail.setContent(emailTemplate);mailService.sendHtmlMail(mail);} ❝ 模板文件：src/main/resources/templates/emailTemplate.html
❞<!DOCTYPE html> <html lang="en"xmlns="http://www.w3.org/1999/xhtml"xmlns:th="http://www.thymeleaf.org"> <head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>mail</title> </head> <body><table align="center" cellpadding="0" cellspacing="0" width="600px"><tr><td><table align="center" border="0" cellpadding="0" cellspacing="0" width="600"style="border-collapse: collapse;"><tr><td align="center" style="padding: 40px 0 30px 0;"><img src='你的图片地址' style='width:183px height:47.50px'></td></tr><tr><td bgcolor="#ffffff" style="padding: 0px 30px 20px 30px"><h3>产品名称变更通知</h3><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td colspan="2" style="padding: 0 0 3px 0">通知事项：<span th:text="${emailParam.name}"></span></td></tr><tr><td style="padding: 12px 0 3px 0">产品名称：<span th:text="${emailParam.content}"></span></td></tr><tr><td style="padding: 12px 0 3px">审批人：<span th:text="${emailParam.person}"></span></td></tr></table></td></tr></table></td></tr></table> </body> </html>

效果如图：

6、完整代码

❝ Entity---邮件信息实体类：com.scaffold.test.entity.Mail
❞package com.scaffold.test.entity;import lombok.Data;@Data public class Mail {// 发送给谁private String to;// 发送主题private String subject;// 发送内容private String content;// 附件地址private String filePath; }❝ Service---邮件服务接口：com.scaffold.test.service.MailService
❞package com.scaffold.test.service;import com.scaffold.test.entity.Mail;import javax.mail.MessagingException;public interface MailService {// 发送邮件public void sendMail(Mail mail);// 发送Html邮件public void sendHtmlMail(Mail mail) throws MessagingException;// 发送带附件的邮件public void sendAttachmentsMail(Mail mail) throws MessagingException; } ❝ ServiceImpl---邮件服务接口实现类：com.scaffold.test.service.impl.MailServiceImpl
❞package com.scaffold.test.service.impl;import com.scaffold.test.entity.Mail; import com.scaffold.test.service.MailService; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.core.io.FileSystemResource; import org.springframework.mail.SimpleMailMessage; import org.springframework.mail.javamail.JavaMailSender; import org.springframework.mail.javamail.MimeMessageHelper; import org.springframework.stereotype.Service;import javax.mail.internet.MimeMessage; import java.io.File;@Service public class MailServiceImpl implements MailService {Logger logger = LoggerFactory.getLogger(this.getClass());@Autowiredprivate JavaMailSender mailSender;@Value("${mail.fromMail.addr}")private String mailFrom;// 只发送文本@Overridepublic void sendMail(Mail mail) {SimpleMailMessage message = new SimpleMailMessage();message.setFrom(mailFrom);message.setTo(mail.getTo());message.setSubject(mail.getSubject());message.setText(mail.getContent());mailSender.send(message);logger.info("发送完毕");}// 发送Html邮件@Overridepublic void sendHtmlMail(Mail mail) {MimeMessage message = mailSender.createMimeMessage();try {MimeMessageHelper helper = new MimeMessageHelper(message, true);message.setFrom(mailFrom);helper.setTo(mail.getTo());helper.setSubject(mail.getSubject());helper.setText(mail.getContent(), true);mailSender.send(message);logger.info("发送Html邮件成功");} catch (Exception e) {e.printStackTrace();logger.error("发送Html邮件失败");}}// 发送带附件的邮件@Overridepublic void sendAttachmentsMail(Mail mail) {MimeMessage message = mailSender.createMimeMessage();try {MimeMessageHelper helper = new MimeMessageHelper(message, true);message.setFrom(mailFrom);helper.setTo(mail.getTo());helper.setSubject(mail.getSubject());helper.setText(mail.getContent(), true);// 附件FileSystemResource resourse = new FileSystemResource(new File(mail.getFilePath()));// 添加附件helper.addAttachment("test.png", resourse);mailSender.send(message);logger.info("发送邮件成功");} catch (Exception e) {e.printStackTrace();logger.error("发送邮件失败");}} } ❝ Controller---发邮件控制器：com.scaffold.test.controller.MailController
❞package com.scaffold.test.controller;import com.scaffold.test.entity.Mail; import com.scaffold.test.service.MailService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.scheduling.annotation.Async; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import org.thymeleaf.context.Context; import org.thymeleaf.spring5.SpringTemplateEngine;import javax.mail.MessagingException; import java.util.HashMap; import java.util.Map;@RestController @RequestMapping("/mail") public class MailController {@Autowiredprivate MailService mailService;@Autowiredprivate SpringTemplateEngine templateEngine;// 发送不带格式的文本@Async@GetMapping("post")public void postMail() {Mail mail = new Mail();mail.setTo("**@qq.com");mail.setSubject("automatic");mail.setContent("自动邮件发布");mailService.sendMail(mail); // return ResultGenerator.getSuccessResult().setMessage("发送成功");}// 发送Html邮件@Async@GetMapping("postHtml")public void postHtmlMail() throws MessagingException {String content = "<html>n" +"<body>n" +"<h3>hello! test Html test!</h3>n" +"</body>n" +"</html>";Mail mail = new Mail();mail.setTo("***@qq.com");mail.setSubject("Html格式邮件");mail.setContent(content);mailService.sendHtmlMail(mail); // return ResultGenerator.getSuccessResult().setMessage("发送成功");}// 发送带附件的邮件@Async@GetMapping("postAttachment")public void postAttachmentsMail() throws MessagingException {Mail mail = new Mail();mail.setTo("****@qq.com");mail.setSubject("附件");mail.setContent("有附件，赶紧看下");mail.setFilePath("E:test.png");mailService.sendAttachmentsMail(mail); // return ResultGenerator.getSuccessResult().setMessage("发送成功");}// 发送 Html 模板邮件@Async@GetMapping("postTemplate")public void postTemplateMail() throws MessagingException {Context context = new Context();Map<String, Object> emailParam = new HashMap<>();emailParam.put("name", "产品终端更换名字");emailParam.put("content", "牛牛终端");emailParam.put("person", "Alex Wong");context.setVariable("emailParam", emailParam);String emailTemplate = templateEngine.process("emailTemplate", context);Mail mail = new Mail();mail.setTo("***@qq.com");mail.setSubject("模板邮件");mail.setContent(emailTemplate);mailService.sendHtmlMail(mail); // return ResultGenerator.getSuccessResult().setMessage("发送成功");}}

总结

以上是生活随笔为你收集整理的flask-mail异步发送邮件_spring Boot手把手教学(6)：发送邮件的全部内容，希望文章能够帮你解决所遇到的问题。

如果觉得生活随笔网站内容还不错，欢迎将生活随笔推荐给好友。