SpringBoot实现邮件的发送

一 依赖导入

导入 Spring 官方 将 jakarta.mail 又进行进一步封装成开箱即用的 spring-boot-starter-mail 的maven坐标

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

二 邮件配置

spring-boot-starter-mail的配置由MailProperties配置类提供。在 application.yml 配置文件中以 spring.mail为前缀

############### 邮件配置

#  字符集编码 默认 UTF-8
spring.mail.default-encoding=UTF-8
# SMTP 服务器 host  qq邮箱的为 smtp.qq.com 端口 465 587
#spring.mail.host=smtp.qq.com
# SMTP 服务器端口 不同的服务商不一样
#spring.mail.port=465
#   SMTP 服务器使用的协议
#spring.mail.protocol=smtp
# SMTP服务器需要身份验证 所以 要配置用户密码
# 发送端的用户邮箱名
#spring.mail.username=xxxx@qq.com
# 发送端的密码 注意保密
#spring.mail.password=oooooxxxxxxxx

#QQ邮箱设置
# 需要开启 smtp
spring.mail.host=smtp.qq.com
spring.mail.port=465
# 发件人的邮箱
spring.mail.username=xxx@qq.com
# qq 邮箱的第三方授权码 并非个人密码
spring.mail.password=xxx
#开启ssl 否则 503 错误
spring.mail.properties.mail.smtp.ssl.enable=true

#163邮箱设置
# 需要在设置中开启 smtp
#spring.mail.host=smtp.163.com
#spring.mail.port=465
# 发件人的邮箱
#spring.mail.username=xxx@163.com
# 邮箱的授权码 并非个人密码
#spring.mail.password=xxx
#spring.mail.properties.mail.smtp.ssl.enable=true
#spring.mail.properties.mail.imap.ssl.socketFactory.fallback=false
#spring.mail.properties.mail.smtp.ssl.socketFactory.class=javax.net.ssl.SSLSocketFactory
#spring.mail.properties.mail.smtp.auth=true
#spring.mail.properties.mail.smtp.starttls.enable=true
#spring.mail.properties.mail.smtp.starttls.required=true

#Gmail邮箱设置
#spring.mail.host=smtp.gmail.com
#spring.mail.port=587
#spring.mail.username=xxx@gmail.com
# 安全建议使用应用程序密码代替Gmail密码。参见相关文档
#spring.mail.password=xxx
# 个性配置
#spring.mail.properties.mail.debug=true
#spring.mail.properties.mail.transport.protocol=smtp
#spring.mail.properties.mail.smtp.auth=true
#spring.mail.properties.mail.smtp.connectiontimeout=5000
#spring.mail.properties.mail.smtp.timeout=5000
#spring.mail.properties.mail.smtp.writetimeout=5000
# TLS , port 587
#spring.mail.properties.mail.smtp.starttls.enable=true
# SSL, post 465
#spring.mail.properties.mail.smtp.socketFactory.port = 465
#spring.mail.properties.mail.smtp.socketFactory.class = javax.net.ssl.SSLSocketFactory

#outlook邮箱配置
#spring.mail.host=smtp-mail.outlook.com
#spring.mail.port=587
#spring.mail.username=xxx@outlook.com
#spring.mail.password=xxx
#spring.mail.properties.mail.protocol=smtp
#spring.mail.properties.mail.tls=true
#spring.mail.properties.mail.smtp.auth=true
#spring.mail.properties.mail.smtp.starttls.enable=true
#spring.mail.properties.mail.smtp.ssl.trust=smtp-mail.outlook.com

# 指定mail会话的jndi名称 优先级较高   一般我们不使用该方式
spring.mail.jndi-name=
# 这个比较重要 针对不同的SMTP服务器 都有自己的一些特色配置该属性 提供了这些配置的 key value 封装方案 例如 Gmail SMTP 服务器超时配置 spring.mail.properties.mail.smtp.timeout= 5000
spring.mail.properties.<key> =
# 指定是否在启动时测试邮件服务器连接，默认为false
spring.mail.test-connection=false

三 java代码工具类

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.messaging.MessagingException;
import org.springframework.stereotype.Component;

import javax.mail.internet.MimeMessage;
import java.io.File;

/**
 * 邮件发送工具类
 *
 * @version v1.0
 * @Author: mxlFuture
 * @Date: 2020/1/15
 */
@Component
public class EmailUtil {
    @Autowired
    private JavaMailSender javaMailSender;
    @Value("${spring.mail.username}")
    private String from;

    /**
     * 发送纯文本邮件.
     *
     * @param to      目标email 地址
     * @param subject 邮件主题
     * @param text    纯文本内容
     */
    public void sendMail(String to, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();

        message.setFrom(from);
        message.setTo(to);
        message.setSubject(subject);
        message.setText(text);
        javaMailSender.send(message);
    }

    /**
     * 发送邮件并携带附件.
     * 请注意 from 、 to 邮件服务器是否限制邮件大小
     *
     * @param to       目标email 地址
     * @param subject  邮件主题
     * @param text     纯文本内容
     * @param filePath 附件的路径 当然你可以改写传入文件
     */
    public void sendMailWithAttachment(String to, String subject, String text, String filePath) throws MessagingException, javax.mail.MessagingException {

        File attachment = new File(filePath);
        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper helper=new MimeMessageHelper(mimeMessage,true);
        helper.setFrom(from);
        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(text);
        helper.addAttachment(attachment.getName(),attachment);
        javaMailSender.send(mimeMessage);

    }
    /**
     * 发送富文本邮件.
     *
     * @param to       目标email 地址
     * @param subject  邮件主题
     * @param text     纯文本内容
     * @param filePath 附件的路径 当然你可以改写传入文件
     */
    public void sendRichMail(String to, String subject, String text, String filePath) throws MessagingException, javax.mail.MessagingException {

        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper helper=new MimeMessageHelper(mimeMessage,true);
        helper.setFrom(from);
        helper.setTo(to);
        helper.setSubject(subject);

        helper.setText(text,true);
        // 图片占位写法  如果图片链接写入模板 注释下面这一行
        helper.addInline("qr",new FileSystemResource(filePath));
        javaMailSender.send(mimeMessage);

    }
}

四 测试

纯文本邮件测试

@RestController
public class EmailDemoController {

    @Autowired
    private EmailUtil emailUtil;

    @RequestMapping("/demoEmail")
    public Map<String,Object> sendMailDemo(){
        HashMap<String, Object> resMap = new HashMap<>(16);

        String to="xxx";
        String subject="主题";
        String text="内容文本";
        emailUtil.sendMail(to,subject,text);

        resMap.put("status","200");
        resMap.put("msg","发送成功");

        return resMap;
    }

}

成功接收到邮件