SpringBoot集成Java Mail实现邮件发送功能

骑猪看日落 2022-05-18 01:42 292阅读 0赞

# SpringBoot集成Java Mail实现邮件发送功能 #

## 概述 ##

springboot-email是基于SpringBoot环境集成Java Mail，并实现了邮件发送功能，包括简易邮件发送、html正文邮件发送、内联资源（静态资源）邮件发送、模板邮件发送

## 实现步骤分析 ##

### 引入相关依赖 ###

<dependencies>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
    
    </dependencies>

### 创建application.yml文件 ###

spring:
      mail:
        host: smtp.qq.com # QQ邮箱smtp主机
        port: 587 #端口号465或587
        username: test@qq.com
        password: dxbrcmxjktzqbbhj  # 这里QQ邮箱开通POP3/SMTP提供的授权码，如果邮箱服务商没有授权码，可以使用密码代替
        protocol: smtp
        default-encoding: UTF-8

### 创建springboot-email启动类 ###

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.CommandLineRunner;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.thymeleaf.TemplateEngine;
    import org.thymeleaf.context.Context;
    
    import cn.tyrone.springboot.mail.util.MailBean;
    import cn.tyrone.springboot.mail.util.MailUtil;
    
    @SpringBootApplication
    public class Application implements CommandLineRunner { 
    
        private static final Logger log = LoggerFactory.getLogger(Application.class);
    
        @Autowired MailUtil mailUtil;
        // 注入模板引擎
        @Autowired TemplateEngine templateEngine;
    
        public static void main(String[] args) throws Exception {
            SpringApplication.run(Application.class, args);
        }
    
        @Override
        public void run(String... args) throws Exception {
            log.info("------------- SpringBoot集成JavaMail实现邮件发送开始 -------------");
            MailBean mailBean = MailBean.getMailBean();
            /* * 简易邮件发送测试 */
    // mailBean.setSubject("SpringBoot集成JavaMail实现邮件发送");
    // mailBean.setText("SpringBoot集成JavaMail实现简易邮件发送功能");
    // mailUtil.sendMail(mailBean);
    
            /** * HTML邮件正文发送测试 */
    // String html = 
    // "<html>"
    // + "<body>"
    // + "<p><h1>SpringBoot集成JavaMail实现正文为HTML的邮件发送功能</h1></p>"
    // + "</body>"
    // + "</html>";
    // mailBean.setSubject("SpringBoot集成JavaMail实现邮件发送");
    // mailBean.setText(html);
    // mailUtil.sendMailHtml(mailBean);
    
            /** * 附件邮件发送测试 */
    // String filePath="/Users/shanglishuai/Downloads/Jietu20180727-144621@2x.jpg";
    // FileSystemResource file = new FileSystemResource(new File(filePath));
    // String attachmentFilename = filePath.substring(filePath.lastIndexOf(File.separator));
    // mailBean.setSubject("SpringBoot集成JavaMail实现邮件发送");
    // mailBean.setText("SpringBoot集成JavaMail实现附件邮件发送");
    // mailBean.setFile(file);
    // mailBean.setAttachmentFilename(attachmentFilename);
    // mailUtil.sendMailAttachment(mailBean);
    
    
            /** * 内联资源邮件发送测试 */
    // String filePath="/Users/shanglishuai/Downloads/Jietu20180727-144621@2x.jpg";
    // String contentId = UUID.randomUUID().toString().replace("-", "");
    // /*
    // * <img src=\'cid:" + contentId + "\' >
    // * cdi:是固定的，其后连接内联资源的的ID（保证唯一即可）
    // */
    // String content = "<html><body>内联资源邮件发送：<img src=\'cid:" + contentId + "\' ></body></html>";
    // FileSystemResource file = new FileSystemResource(new File(filePath));
    // mailBean.setSubject("SpringBoot集成JavaMail实现邮件发送");
    // mailBean.setText(content);
    // mailBean.setFile(file);
    // mailBean.setContentId(contentId);
    // mailUtil.sendMailInline(mailBean);
    
            Context context = new Context();
            context.setVariable("user", "Tyrone");
            String content = templateEngine.process("emailTemplate", context);
            mailBean.setSubject("SpringBoot集成JavaMail实现邮件发送");
            mailBean.setText(content);
            mailUtil.sendMailTemplate(mailBean);
    
            log.info("------------- SpringBoot集成JavaMail实现邮件发送结束 -------------");
        }
    }

为了便于测试，启动类直接实现`CommandLineRunner`接口，并重写`run`方法来实现邮件发送的测试

### 创建发送邮件工具类 ###

import javax.mail.MessagingException;
    import javax.mail.internet.MimeMessage;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.mail.SimpleMailMessage;
    import org.springframework.mail.javamail.JavaMailSender;
    import org.springframework.mail.javamail.MimeMessageHelper;
    import org.springframework.stereotype.Component;
    
    @Component
    public class MailUtil { 
    
        @Autowired
        private JavaMailSender mailSender; // 自动注入的Bean
    
        @Value("${spring.mail.username}")
        private String sender; // 读取配置文件中的参数
    
        /** * 发送邮件测试方法 */
        public void sendMail() {
            SimpleMailMessage mimeMessage = new SimpleMailMessage();
            mimeMessage.setFrom(sender);
            mimeMessage.setTo(sender);
            mimeMessage.setSubject("SpringBoot集成JavaMail实现邮件发送");
            mimeMessage.setText("SpringBoot集成JavaMail实现邮件发送正文");
            mailSender.send(mimeMessage);
        }
    
        /** * 发送简易邮件 * @param mailBean */
        public void sendMail(MailBean mailBean) {
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage);
    
            try {
                helper.setFrom(sender);
                helper.setTo(sender);
                helper.setSubject(mailBean.getSubject());
                helper.setText(mailBean.getText());
            } catch (MessagingException e) {
                e.printStackTrace();
            }
    
            mailSender.send(mimeMessage);
        }
    
        /** * 发送邮件-邮件正文是HTML * @param mailBean */
        public void sendMailHtml(MailBean mailBean) {
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage);
    
            try {
                helper.setFrom(sender);
                helper.setTo(sender);
                helper.setSubject(mailBean.getSubject());
                helper.setText(mailBean.getText(), true);
            } catch (MessagingException e) {
                e.printStackTrace();
            }
    
            mailSender.send(mimeMessage);
        }
        /** * 发送邮件-附件邮件 * @param mailBean */
        public void sendMailAttachment(MailBean mailBean) {
            try {
                MimeMessage mimeMessage = mailSender.createMimeMessage();
                MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
                helper.setFrom(sender);
                helper.setTo(sender);
                helper.setSubject(mailBean.getSubject());
                helper.setText(mailBean.getText(), true);
                // 增加附件名称和附件
                helper.addAttachment(mailBean.getAttachmentFilename(), mailBean.getFile());
                mailSender.send(mimeMessage);
            } catch (MessagingException e) {
                e.printStackTrace();
            }
        }
    
        /** * 内联资源（静态资源）邮件发送 * 由于邮件服务商不同，可能有些邮件并不支持内联资源的展示 * 在测试过程中，新浪邮件不支持，QQ邮件支持 * 不支持不意味着邮件发送不成功，而且内联资源在邮箱内无法正确加载 * @param mailBean */
        public void sendMailInline(MailBean mailBean) {
            try {
                MimeMessage mimeMessage = mailSender.createMimeMessage();
                MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
                helper.setFrom(sender);
                helper.setTo(sender);
                helper.setSubject(mailBean.getSubject());
    
                /* * 内联资源邮件需要确保先设置邮件正文，再设置内联资源相关信息 */
                helper.setText(mailBean.getText(), true);
                helper.addInline(mailBean.getContentId(), mailBean.getFile());
    
                mailSender.send(mimeMessage);
            } catch (MessagingException e) {
                e.printStackTrace();
            }
        }
    
        /** * 模板邮件发送 * @param mailBean */
        public void sendMailTemplate(MailBean mailBean) {
            try {
                MimeMessage mimeMessage = mailSender.createMimeMessage();
                MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
                helper.setFrom(sender);
                helper.setTo(sender);
                helper.setSubject(mailBean.getSubject());
                helper.setText(mailBean.getText(), true);
                mailSender.send(mimeMessage);
            } catch (MessagingException e) {
                e.printStackTrace();
            }
        }
    
    }

### 创建Mail实体类 ###

import org.springframework.core.io.FileSystemResource;
    
    import lombok.Data;
    
    /** * 邮件实体类 * * @author shanglishuai * */
    @Data // 通过lombok提供的相关注解实现简化实体构造
    public class MailBean { 
        /** * 邮件主题 */
        private String subject;
    
        /** * 邮件内容 */
        private String text;
    
        /** * 附件 */
        private FileSystemResource file;
    
        /** * 附件名称 */
        private String attachmentFilename;
    
        /** * 内容ID，用于发送静态资源邮件时使用 */
        private String contentId;
    
        public static MailBean getMailBean() {
            return new MailBean();
        }
    
    }

### 创建邮件模板文件 ###

<!DOCTYPE html>
    <html xmlns:th="http://www.thymeleaf.org">
    <head>
    <meta charset="UTF-8" />
    <title>Insert title here</title>
    </head>
    <body>
        <p>Hello!<span th:text="${user}"></span>!<br /></p>
        这是SpringBoot集成Java Email，并通过Thymeleaf创建邮件模板，实现的模板邮件发送！！！
    </body>
    </html>

注意：根据约定大于配置，模板文件建议放在`resources`目录下。本例：`/resources/templates/emailTemplate.html`

源代码链接：  
[https://github.com/myNameIssls/springboot-study/tree/master/springboot-email][https_github.com_myNameIssls_springboot-study_tree_master_springboot-email]

参考链接：  
[https://docs.spring.io/spring-boot/docs/2.0.3.RELEASE/reference/htmlsingle/\#boot-features-email][https_docs.spring.io_spring-boot_docs_2.0.3.RELEASE_reference_htmlsingle_boot-features-email]  
[https://docs.spring.io/spring/docs/5.0.7.RELEASE/spring-framework-reference/integration.html\#mail][https_docs.spring.io_spring_docs_5.0.7.RELEASE_spring-framework-reference_integration.html_mail]  
[https://javaee.github.io/javamail/][https_javaee.github.io_javamail]  
[https://www.cnblogs.com/ityouknow/p/6823356.html][https_www.cnblogs.com_ityouknow_p_6823356.html]

[https_github.com_myNameIssls_springboot-study_tree_master_springboot-email]: https://github.com/myNameIssls/springboot-study/tree/master/springboot-email
[https_docs.spring.io_spring-boot_docs_2.0.3.RELEASE_reference_htmlsingle_boot-features-email]: https://docs.spring.io/spring-boot/docs/2.0.3.RELEASE/reference/htmlsingle/#boot-features-email
[https_docs.spring.io_spring_docs_5.0.7.RELEASE_spring-framework-reference_integration.html_mail]: https://docs.spring.io/spring/docs/5.0.7.RELEASE/spring-framework-reference/integration.html#mail
[https_javaee.github.io_javamail]: https://javaee.github.io/javamail/
[https_www.cnblogs.com_ityouknow_p_6823356.html]: https://www.cnblogs.com/ityouknow/p/6823356.html

发表评论取消回复

表情：

评论列表（有 0 条评论，292人围观）

还没有评论，来说两句吧...

相关阅读

相关 SpringBoot中整合Mail实现发送模板邮件

场景项目搭建专栏： [https://blog.csdn.net/BADAO\_LIUMANG\_QIZHI/column/info/35688][https_blo

妖狐艹你老母/ 2023年10月18日 17:07/ 0 赞/ 151 阅读

相关 SpringBoot中整合Mail实现发送邮件

场景项目搭建专栏： [https://blog.csdn.net/BADAO\_LIUMANG\_QIZHI/column/info/35688][https_blo

柔光的暖阳◎/ 2023年10月18日 17:07/ 0 赞/ 182 阅读

相关 Java mail实现HTML邮件的发送

1、前言在现实生活中，我们经常会需要邮件的发送。手动发送已经成为一种耗时又费力的工作，那么如何更高效的利用代码来进行动态的发送呢？可能你又会问，代码编写的文本无法实现一

妖狐艹你老母/ 2023年02月16日 16:20/ 0 赞/ 264 阅读

相关 java springboot 发送电子邮件 mail

1.MailSenderInfo package org.fh.util.mail; / 说明：发送邮件需要使用的基本信息

朴灿烈づ我的快乐病毒、/ 2023年01月05日 15:29/ 0 赞/ 273 阅读

相关 java mail发送邮件

// 创建Properties 类用于记录邮箱的一些属性 final Properties props = new Properties();

清疚/ 2022年06月09日 03:06/ 0 赞/ 264 阅读

相关 SpringBoot集成Java Mail实现邮件发送功能

SpringBoot集成Java Mail实现邮件发送功能概述 springboot-email是基于SpringBoot环境集成Java Mail，并实现了邮件

骑猪看日落/ 2022年05月18日 01:42/ 0 赞/ 293 阅读

相关 SpringBoot发送邮件Mail

今天在idea中使用springboot来实现发送Mail功能，编码很顺利，但是在测试发送邮件时报错， nested exception is: java.

忘是亡心i/ 2022年01月26日 06:37/ 0 赞/ 389 阅读

相关 springboot整合Mail，实现发送邮件功能

实现邮件发送功能步骤：建立springboot项目 ---> 申请qq邮箱授权码 ---> 配置文件 ---> 代码实现目录一、新建springboot服务二、

àì夳堔傛蜴生んèń/ 2022年01月20日 03:51/ 0 赞/ 343 阅读

相关 SpringBoot 集成 Mail发送邮件

今天，日月教大家如何使用springBoot集成mail发送邮件。话不多说，直接上代码。 1、pom依赖 <?xml version="1.0" encoding=

偏执的太偏执、/ 2021年11月09日 04:16/ 0 赞/ 433 阅读

相关 Java 使用 mail.jar 实现邮件发送

目录准备工作使用到的 jar 包实现代码准备工作要想实现邮件发送，需要先打开发送邮箱的 `POP3/SMTP`

我就是我/ 2021年09月21日 15:16/ 0 赞/ 354 阅读