SpringBoot-JavaMailSender接口实战

相信使用过Spring的众多开发者都知道Spring提供了非常好用的JavaMailSender接口实现邮件发送，在Spring Boot的Starter模块中也为此提供了自动化配置。
下面通过实例来讲解如何在Spring Boot中使用JavaMailSender发送邮件。
什么是SMTP？

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

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

SMTP协议
发送邮件：我们通常把处理用户smtp请求(邮件发送请求)的服务器称之为SMTP服务器(邮件发送服务器)。
POP3协议
接收邮件：我们通常把处理用户pop3请求(邮件接收请求)的服务器称之为POP3服务器(邮件接收服务器)。
进阶知识

• 什么是JavaMailSender和JavaMailSenderImpl？
  

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

• 如何通过JavaMailSenderImpl发送邮件？‘
  

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

1.     @Autowired
2.     private JavaMailSenderImpl mailSender;
4.     public void sendMail() throws MessagingException {
5.         //简单邮件
6.         SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
7.         simpleMailMessage.setFrom("admin@163.com");
8.         simpleMailMessage.setTo("socks@qq.com");
9.         simpleMailMessage.setSubject("Happy New Year");
10.         simpleMailMessage.setText("新年快乐！");
11.         mailSender.send(simpleMailMessage);
13.         //复杂邮件
14.         MimeMessage mimeMessage = mailSender.createMimeMessage();
15.         MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage);
16.         messageHelper.setFrom("admin@163.com");
17.         messageHelper.setTo("socks@qq.com");
18.         messageHelper.setSubject("Happy New Year");
19.         messageHelper.setText("新年快乐！");
20.         messageHelper.addInline("doge.gif", new File("xx/xx/doge.gif"));
21.         messageHelper.addAttachment("work.docx", new File("xx/xx/work.docx"));
22.         mailSender.send(mimeMessage);
23.     }

复制代码

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

1. @Configuration
2. @ConditionalOnProperty(prefix = "spring.mail", name = "host")
3. class MailSenderPropertiesConfiguration {
4.     private final MailProperties properties;
5.     MailSenderPropertiesConfiguration(MailProperties properties) {
6.         this.properties = properties;
7.     }
8.     @Bean
9.     @ConditionalOnMissingBean
10.     public JavaMailSenderImpl mailSender() {
11.         JavaMailSenderImpl sender = new JavaMailSenderImpl();
12.         applyProperties(sender);
13.         return sender;
14. }

复制代码

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

1. @ConfigurationProperties(prefix = "spring.mail")
2. public class MailProperties {
3.     private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
4.     private String host;
5.     private Integer port;
6.     private String username;
7.     private String password;
8.     private String protocol = "smtp";
9.     private Charset defaultEncoding = DEFAULT_CHARSET;
10.     private Map<String, String> properties = new HashMap<>();
11. }

复制代码

实现

1.开启邮件服务

这里以QQ邮箱为例。
首先登录QQ邮箱>>>登录成功后找到设置>>>然后找到邮箱设置>>>点击账户>>>找到POP3|SMTP服务>>>点击开启(开启需要验证，验证成功后会有一串授权码用于发送邮件使用)>>>验证成功
<img alt="image-20221008154945207" loading="lazy">
引入依赖

在springboot项目中，引入如下依赖：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4.     <modelVersion>4.0.0</modelVersion>
5.     <parent>
6.         <groupId>org.springframework.boot</groupId>
7.         <artifactId>spring-boot-starter-parent</artifactId>
8.         <version>2.7.4</version>
9.         <relativePath/>
10.     </parent>
11.     <groupId>com.galaxy</groupId>
12.     <artifactId>MailSender</artifactId>
13.     <version>0.0.1-SNAPSHOT</version>
14.     <name>MailSender</name>
15.     <description>MailSender</description>
16.     <properties>
17.         <java.version>1.8</java.version>
18.     </properties>
19.     <dependencies>
20.         <dependency>
21.             <groupId>org.springframework.boot</groupId>
22.             <artifactId>spring-boot-starter-web</artifactId>
23.         </dependency>
25.         <dependency>
26.             <groupId>org.springframework.boot</groupId>
27.             <artifactId>spring-boot-starter-test</artifactId>
28.             <scope>test</scope>
29.         </dependency>
31.         <dependency>
32.             <groupId>org.springframework.boot</groupId>
33.             <artifactId>spring-boot-starter-mail</artifactId>
34.         </dependency>
36.         <dependency>
37.             <groupId>org.apache.commons</groupId>
38.             <artifactId>commons-lang3</artifactId>
39.             <version>3.10</version>
40.         </dependency>
42.     </dependencies>
44.     <build>
45.         <plugins>
46.             <plugin>
47.                 <groupId>org.springframework.boot</groupId>
48.                 <artifactId>spring-boot-maven-plugin</artifactId>
49.             </plugin>
50.         </plugins>
51.     </build>
53. </project>

复制代码

application.yml配置

在配置文件application.yml文件中写入发送邮件的配置信息

1. # 服务端口
2. server:
3.   port: 8083
5. spring:
6.   #邮箱基本配置
7.   mail:
8.     #配置smtp服务主机地址
9.     # qq邮箱为smtp.qq.com          端口号465或587
10.     # sina    smtp.sina.cn
11.     # aliyun  smtp.aliyun.com
12.     # 163     smtp.163.com       端口号465或994
13.     host: smtp.qq.com
14.     #发送者邮箱
15.     username: 896668626@qq.com
16.     #配置密码,注意不是真正的密码，而是刚刚申请到的授权码
17.     password: gltiixjllkakxobfjd
18.     #端口号465或587
19.     port: 587
20.     #默认的邮件编码为UTF-8
21.     default-encoding: UTF-8
22.     #其他参数
23.     properties:
24.      mail:
25.         #配置SSL 加密工厂
26.       smtp:
27.         ssl:
28.           #本地测试，先放开ssl
29.           enable: false
30.           required: false
31.         #开启debug模式，这样邮件发送过程的日志会在控制台打印出来，方便排查错误
32.       debug: true

复制代码

注:配置 SpringBoot 启动端口还可以通过IDEA 本身的配置来指定启动端口

• 第一步
  
  
• 第二步
  
  

编写发送邮件方法

编写邮件业务类MailService.
主要通过MailService工具类就可以满足发送java邮件的需要。当我们进行好 yml 配置后，SpringBoot会帮助我们自动配置 JavaMailSender 我们通过这个java类就可以实现操作java来发送邮件。
发送纯文本邮件

service

1. package com.galaxy.mailsender.service;
5. import org.apache.commons.lang3.StringUtils;
6. import org.springframework.beans.factory.annotation.Autowired;
7. import org.springframework.beans.factory.annotation.Value;
8. import org.springframework.mail.javamail.JavaMailSenderImpl;
9. import org.springframework.mail.javamail.MimeMessageHelper;
10. import org.springframework.stereotype.Service;
11. import javax.mail.MessagingException;
12. import java.util.Date;
14. /**
15. * 邮件业务类
16. * @author Galaxy
17. */
18. @Service
19. public class MailService {
20.     /**
21.      * 注入邮件工具类
22.      */
23.     @Autowired
24.     private JavaMailSenderImpl javaMailSender;
26.     @Value("${spring.mail.username}")
27.     private String sendMailer;
29.     /**
30.      * 检测邮件信息类
31.      * @param to
32.      * @param subject
33.      * @param text
34.      */
35.     private void checkMail(String to,String subject,String text){
36.         if(StringUtils.isEmpty(to)){
37.             throw new RuntimeException("邮件收信人不能为空");
38.         }
39.         if(StringUtils.isEmpty(subject)){
40.             throw new RuntimeException("邮件主题不能为空");
41.         }
42.         if(StringUtils.isEmpty(text)){
43.             throw new RuntimeException("邮件内容不能为空");
44.         }
45.     }
47.     /**
48.      * 发送纯文本邮件
49.      * @param to
50.      * @param subject
51.      * @param text
52.      */
53.     public void sendTextMailMessage(String to,String subject,String text){
55.         try {
56.             //true 代表支持复杂的类型
57.             MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(javaMailSender.createMimeMessage(),true);
58.             //邮件发信人
59.             mimeMessageHelper.setFrom(sendMailer);
60.             //邮件收信人  1或多个
61.             mimeMessageHelper.setTo(to.split(","));
62.             //邮件主题
63.             mimeMessageHelper.setSubject(subject);
64.             //邮件内容
65.             mimeMessageHelper.setText(text);
66.             //邮件发送时间
67.             mimeMessageHelper.setSentDate(new Date());
69.             //发送邮件
70.             javaMailSender.send(mimeMessageHelper.getMimeMessage());
71.             System.out.println("发送邮件成功："+sendMailer+"->"+to);
73.         } catch (MessagingException e) {
74.             e.printStackTrace();
75.             System.out.println("发送邮件失败："+e.getMessage());
76.         }
77.     }
78. }

复制代码

Controller

1. package com.galaxy.mailsender.controller;
3. import com.galaxy.mailsender.service.MailService;
4. import org.springframework.beans.factory.annotation.Autowired;
5. import org.springframework.web.bind.annotation.RequestMapping;
6. import org.springframework.web.bind.annotation.RestController;
8. @RestController
9. public class MailController {
10.     @Autowired
11.     private MailService mailService;
14.     /**
15.      * 发送文本邮件
16.      * @param to
17.      * @param subject
18.      * @param text
19.      */
20.     @RequestMapping("/sendTextMail")
21.     public void sendTextMail(String to,String subject,String text){
22.         mailService.sendTextMailMessage(to,subject,text);
23.     }
24. }

复制代码

测试



结果


补充

发送html邮件

Spring Boot支持使用HTML发送邮件是通过MimeMessage来完成的。
发送带附件的邮件

MimeMessageHelper支持发送复杂邮件模板，支持文本、附件、HTML、图片等。比如需要发送附件，则在上面的代码中通过调用helper的addAttachment(fileName, file)方法即可。
例:发送HTML邮件

1. package com.example.emaildemo.controller;
3. import com.example.emaildemo.service.MailService;
4. import org.springframework.beans.factory.annotation.Autowired;
5. import org.springframework.web.bind.annotation.RequestMapping;
6. import org.springframework.web.bind.annotation.RestController;
8. /**
9. * 测试邮件发送
10. * @author galaxy
11. */
12. @RestController
13. public class SendMailController {
15.     @Autowired
16.     private MailService mailService;
17.     /**
18.      * 发送HTML邮件
19.      * @param to
20.      * @param subject
21.      * @param content
22.      */
23.     @RequestMapping("/sendHtmlMailMessage")
24.     public void sendHtmlMailMessage(String to,String subject,String content){
25.         mailService.sendHtmlMailMessage(to,subject,content);
26.     }
27. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！