三分钟教会你如何使用SpringBoot发送邮

点击关注公众号，更多资讯及时推送↓

介绍

相信使用过Spring 的朋友们都知道， Spring  提供了一个非常方便快捷 的接口来实现邮件发送 （JavaMailSender）， 在 Spring Boot 的 依赖管理中也为此提供了自动化的配置，接下来就通过实例来说一说 如何在 Spring Boot 中 使用 JavaMailSender 来发送邮件。

一、前言

        在实际项目开发过程中，可能会用到发送邮件的功能，例如：用户忘记密码，通过邮件找回密码，或者通过邮件发送系统情况给个人等等，这篇文章就带大家了解通过 SpringBoot 快速实现一个发送邮件的功能。

 1.1基本了解

   什么是SMTP协议

     SMTP （Simple Mail Transfer Protocol：简单邮件传输协议），这是一种用来从源地址向目标地址发送邮件的规格，通过 SMTP 来控制邮件的中转方式，其中 SMTP 协议认证必须要求提供账号和密码方可登录服务器，。

什么是POP3？
        POP3 （Post Office Protocol 3: 邮局协议）：此协议支持客户端远程管理服务器， 经常用于 “离线” 邮件处理，目前很多POP3 的邮件服务器只提供下载邮件的功能，服务器本身其实并不删除邮件。

2.传输协议

SMTP协议
发送邮件：我们通常把处理用户smtp请求(邮件发送请求)的服务器称之为SMTP服务器(邮件发送服务器)。

POP3协议
接收邮件：我们通常把处理用户pop3请求(邮件接收请求)的服务器称之为POP3服务器(邮件接收服务器)。

3.进阶知识

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

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

        

二、代码实现

这里使用 QQ邮箱举例，开启邮件服务功能

首先登录QQ邮箱>>>登录成功后找到设置>>>然后找到邮箱设置>>>点击账户>>>找到POP3|SMTP服务>>>点击开启(开启需要验证，验证成功后会有一串授权码用于发送邮件使用)>>>验证成功

以上步骤完成之后，就可以开始开发了。

2.项目创建，引入依赖

构建一个 springboot项目中，引入如下依赖：

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-web</artifactId>  
</dependency>  
<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-mail</artifactId>  
</dependency>

3.application.yml配置

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

# 服务端口
server:
  port: 8083

spring:
  #邮箱基本配置
  mail:
    #配置smtp服务主机地址
    # qq邮箱为smtp.qq.com 端口号465或587
    # sina smtp.sina.cn
    # aliyun smtp.aliyun.com
    # 163 smtp.163.com 端口号465或994
    host: smtp.qq.com
    #发送者邮箱
    username: 2371584307@qq.com
    #配置密码,注意不是真正的密码，而是刚刚申请到的授权码
    password: xlvpnfffcyxdecib
    #端口号465或587
    port: 587
    #默认的邮件编码为UTF-8
    default-encoding: UTF-8
    #其他参数
    properties:
     mail:
        #配置SSL 加密工厂
      smtp:
        ssl:
          #本地测试，先放开ssl
          enable: false
          required: false
        #开启debug模式，这样邮件发送过程的日志会在控制台打印出来，方便排查错误
      debug: true

#

4.编写发送邮件的方法

编写一个邮件业务类， MailService ，总共有三钟发送邮件的类型： 发送中文本邮件，发送html邮件，和带有附件类型的邮件。

这些主要通过 MailService 工具类就可以满足发送邮件的需求，当我们配置好 Mail 后 Spring Boot 会自动帮我们配置 JavaMailSender 我们就可以实现 Java 来发送邮件了。

4.1 发送纯文本邮件

package com.example.emaildemo.service;

import org.apache.commons.lang3.StringUtils;
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.mail.javamail.JavaMailSenderImpl;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Service;
import javax.mail.MessagingException;
import java.util.Date;

/**
 * 邮件业务类
 * @author qzz
 */
@Service
public class MailService {
    private static final Logger logger = LoggerFactory.getLogger(MailService.class);

    /**
     * 注入邮件工具类
     */
    @Autowired
    private JavaMailSenderImpl javaMailSender;

    @Value("${spring.mail.username}")
    private String sendMailer;

    /**
     * 检测邮件信息类
     * @param to
     * @param subject
     * @param text
     */
    private void checkMail(String to,String subject,String text){
        if(StringUtils.isEmpty(to)){
            throw new RuntimeException("邮件收信人不能为空");
        }
        if(StringUtils.isEmpty(subject)){
            throw new RuntimeException("邮件主题不能为空");
        }
        if(StringUtils.isEmpty(text)){
            throw new RuntimeException("邮件内容不能为空");
        }
    }

    /**
     * 发送纯文本邮件
     * @param to
     * @param subject
     * @param text
     */
    public void sendTextMailMessage(String to,String subject,String text){

        try {
            //true 代表支持复杂的类型
            MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(javaMailSender.createMimeMessage(),true);
            //邮件发信人
            mimeMessageHelper.setFrom(sendMailer);
            //邮件收信人 1或多个
            mimeMessageHelper.setTo(to.split(","));
            //邮件主题
            mimeMessageHelper.setSubject(subject);
            //邮件内容
            mimeMessageHelper.setText(text);
            //邮件发送时间
            mimeMessageHelper.setSentDate(new Date());

            //发送邮件
            javaMailSender.send(mimeMessageHelper.getMimeMessage());
            System.out.println("发送邮件成功："+sendMailer+"->"+to);

        } catch (MessagingException e) {
            e.printStackTrace();
            System.out.println("发送邮件失败："+e.getMessage());
        }
    }
}

4.2 发送html邮件

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

4.3 发送带附件的邮件

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

5.发送邮件接口

新建SendMailController类，编写测试接口

5.1 发送本邮件

package com.example.emaildemo.controller;

import com.example.emaildemo.service.MailService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 测试邮件发送
 * @author qzz
 */
@RestController
@RequestMapping("/mail")
public class SendMailController {

    @Autowired
    private MailService mailService;


    /**
     * 发送文本邮件
     * @param to
     * @param subject
     * @param text
     */
    @RequestMapping("/sendTextMail")
    public void sendTextMail(String to,String subject,String text){
        mailService.sendTextMailMessage(to,subject,text);
    }

    /**
     * 发送HTML邮件
     * @param to
     * @param subject
     * @param content
     */
    @RequestMapping("/sendHtmlMailMessage")
    public void sendHtmlMailMessage(String to,String subject,String content){
        mailService.sendHtmlMailMessage(to,subject,content);
    }

    /**
     * 发送带附件的邮件
     * @param to
     * @param subject
     * @param content
     */
    @RequestMapping("/sendAttachmentMailMessage")
    public void sendAttachmentMailMessage(String to,String subject,String content,String filePath){
        //本地附件路径
        filePath="D:\\1.png";
        mailService.sendAttachmentMailMessage(to,subject,content,filePath);
    }
}

6.测试发送邮件

启动项目，使用postman进行测试

6.1 测试纯文本邮件发送

在postman中输入如下接口和参数，点击Send

控制台显示，发送邮件成功