使用Spring Boot 3整合邮件服务实现邮件发送功能

于 2024-05-29 18:00:00 发布
阅读量783 收藏 19
点赞数 10
分类专栏： java 文章标签： spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fudaihb/article/details/139259311
版权

目录

  1. Spring Boot简介

  2. 邮件服务概述

  3. 环境准备

  4. 配置Spring Boot邮件服务

  5. 编写发送邮件的服务

  6. 实现不同类型的邮件发送

  7. 异常处理

  8. 测试邮件发送功能

  9. 总结

1. Spring Boot简介

Spring Boot是由Pivotal团队提供的一个全新的框架，其设计目的是简化新Spring应用的初始搭建以及开发过程。与传统的Spring开发不同，Spring Boot采用了一种“约定优于配置”的理念，使得开发人员可以专注于业务逻辑，而不必花费大量的时间配置框架。

2. 邮件服务概述

邮件服务是计算机网络应用中的一种基础服务，用户可以通过邮件服务收发电子邮件。常见的邮件协议有SMTP、POP3、IMAP等。在Java中，发送邮件可以借助JavaMail API实现，但配置和使用过程相对繁琐。Spring Boot集成了JavaMail，使得邮件发送功能的实现变得更加简便和高效。

3. 环境准备

在开始之前，我们需要准备好以下环境：

  • JDK 11或以上版本

  • Maven 3.6.0或以上版本

  • IDE(如Intellij IDEA)

  • 一些邮件服务提供商，如Gmail、QQ邮箱等

4. 配置Spring Boot邮件服务

首先，我们需要创建一个Spring Boot项目。你可以使用Spring Initializr来快速生成项目模板。

在Spring Initializr中选择以下依赖：

  • Spring Web

  • Spring Boot DevTools

  • Spring Configuration Processor

  • Java Mail Sender

下载并导入项目到你的IDE中。

4.1 修改pom.xml

在pom.xml文件中，添加JavaMail的依赖：


<dependencies>

    <!-- Spring Boot Starter Web -->

    <dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-web</artifactId>

    </dependency>

    

    <!-- Spring Boot Starter Mail -->

    <dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-mail</artifactId>

    </dependency>

    

    <!-- Spring Boot DevTools -->

    <dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-devtools</artifactId>

        <scope>runtime</scope>

        <optional>true</optional>

    </dependency>

</dependencies>

4.2 配置application.yml

接下来，在src/main/resources目录下创建application.yml文件，并添加如下内容：


spring:

  mail:

    host: smtp.example.com # 邮件服务器，如smtp.gmail.com

    port: 587

    username: your-email@example.com

    password: your-email-password

    properties:

      mail:

        smtp:

          auth: true

          starttls:

            enable: true

          ssl:

            trust: "*"

请根据你的邮件服务提供商来修改相应的配置，这里以Gmail为例。对于Gmail，host配置为smtp.gmail.com，端口通常是587，并确保你开启了允许低安全性的应用。

5. 编写发送邮件的服务

5.1 创建邮件服务类

在src/main/java/com/example/email目录下创建一个service包，并添加一个EmailService接口及其实现类EmailServiceImpl。

EmailService接口：


package com.example.email.service;



public interface EmailService {

    void sendSimpleMail(String to, String subject, String content);

    void sendHtmlMail(String to, String subject, String content);

    void sendAttachmentMail(String to, String subject, String content, String filePath);

    void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId);

}

EmailServiceImpl实现类：


package com.example.email.service.impl;



import com.example.email.service.EmailService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.mail.javamail.JavaMailSender;

import org.springframework.mail.javamail.MimeMessageHelper;

import org.springframework.stereotype.Service;

import javax.mail.MessagingException;

import javax.mail.internet.MimeMessage;

import org.springframework.mail.SimpleMailMessage;

import java.io.File;



@Service

public class EmailServiceImpl implements EmailService {



    @Autowired

    private JavaMailSender mailSender;



    // 发送简单邮件

    @Override

    public void sendSimpleMail(String to, String subject, String content) {

        SimpleMailMessage message = new SimpleMailMessage();

        message.setFrom("your-email@example.com");

        message.setTo(to);

        message.setSubject(subject);

        message.setText(content);

        mailSender.send(message);

    }



    // 发送HTML邮件

    @Override

    public void sendHtmlMail(String to, String subject, String content) {

        MimeMessage message = mailSender.createMimeMessage();

        try {

            MimeMessageHelper helper = new MimeMessageHelper(message, true);

            helper.setFrom("your-email@example.com");

            helper.setTo(to);

            helper.setSubject(subject);

            helper.setText(content, true);

        } catch (MessagingException e) {

            e.printStackTrace();

        }

        mailSender.send(message);

    }



    // 发送带附件的邮件

    @Override

    public void sendAttachmentMail(String to, String subject, String content, String filePath) {

        MimeMessage message = mailSender.createMimeMessage();

        try {

            MimeMessageHelper helper = new MimeMessageHelper(message, true);

            helper.setFrom("your-email@example.com");

            helper.setTo(to);

            helper.setSubject(subject);

            helper.setText(content, true);

            File file = new File(filePath);

            helper.addAttachment(file.getName(), file);

        } catch (MessagingException e) {

            e.printStackTrace();

        }

        mailSender.send(message);

    }



    // 发送嵌入资源(如图)的邮件

    @Override

    public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId) {

        MimeMessage message = mailSender.createMimeMessage();

        try {

            MimeMessageHelper helper = new MimeMessageHelper(message, true);

            helper.setFrom("your-email@example.com");

            helper.setTo(to);

            helper.setSubject(subject);

            helper.setText(content, true);

            File file = new File(rscPath);

            helper.addInline(rscId, file);

        } catch (MessagingException e) {

            e.printStackTrace();

        }

        mailSender.send(message);

    }

}

6. 实现不同类型的邮件发送

上面的方法已经实现了多个不同类型邮件的发送，包括文本邮件、html邮件、带附件的邮件及带内嵌资源(图像)的邮件。下面我们通过创建控制器来使用这些功能。

6.1 创建控制器

在src/main/java/com/example/email/controller目录下创建一个EmailController类，并使用RESTful风格的接口来实现邮件发送。


package com.example.email.controller;



import com.example.email.service.EmailService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.*;



@RestController

@RequestMapping("/mail")

public class EmailController {



    @Autowired

    private EmailService emailService;



    @GetMapping("/simple")

    public String sendSimpleMail(@RequestParam String to, @RequestParam String subject, @RequestParam String content) {

        emailService.sendSimpleMail(to, subject, content);

        return "Simple mail sent successfully";

    }



    @GetMapping("/html")

    public String sendHtmlMail(@RequestParam String to, @RequestParam String subject, @RequestParam String content) {

        emailService.sendHtmlMail(to, subject, content);

        return "HTML mail sent successfully";

    }



    @GetMapping("/attachment")

    public String sendAttachmentMail(@RequestParam String to, @RequestParam String subject, @RequestParam String content, @RequestParam String filePath) {

        emailService.sendAttachmentMail(to, subject, content, filePath);

        return "Mail with attachment sent successfully";

    }



    @GetMapping("/inline")

    public String sendInlineResourceMail(@RequestParam String to, @RequestParam String subject, @RequestParam String content, @RequestParam String rscPath, @RequestParam String rscId) {

        emailService.sendInlineResourceMail(to, subject, content, rscPath, rscId);

        return "Mail with inline resource sent successfully";

    }

}

通过上述控制器，我们可以通过不同的HTTP GET请求来触发不同类型的邮件发送。

7. 异常处理

在上述EmailService实现类中，我们简单的使用了e.printStackTrace();来处理异常。实际上，对于生产级的应用，应该使用更为优雅的方式来处理各种可能的异常。

7.1 自定义异常类

在src/main/java/com/example/email/exception目录下创建一个EmailSendException类。


package com.example.email.exception;



public class EmailSendException extends RuntimeException {

    public EmailSendException(String message) {

        super(message);

    }

}

7.2 更新EmailServiceImpl类

更新EmailServiceImpl类中的异常处理部分，将抛出自定义异常EmailSendException。


package com.example.email.service.impl;



import com.example.email.exception.EmailSendException;

import com.example.email.service.EmailService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.mail.javamail.JavaMailSender;

import org.springframework.mail.javamail.MimeMessageHelper;

import org.springframework.stereotype.Service;

import javax.mail.MessagingException;

import javax.mail.internet.MimeMessage;

import org.springframework.mail.SimpleMailMessage;

import java.io.File;



@Service

public class EmailServiceImpl implements EmailService {



    @Autowired

    private JavaMailSender mailSender;



    @Override

    public void sendSimpleMail(String to, String subject, String content) {

        try {

            SimpleMailMessage message = new SimpleMailMessage();

            message.setFrom("your-email@example.com");

            message.setTo(to);

            message.setSubject(subject);

            message.setText(content);

            mailSender.send(message);

        } catch (Exception e) {

            throw new EmailSendException("Failed to send simple mail: " + e.getMessage());

        }

    }



    @Override

    public void sendHtmlMail(String to, String subject, String content) {

        try {

            MimeMessage message = mailSender.createMimeMessage();

            MimeMessageHelper helper = new MimeMessageHelper(message, true);

            helper.setFrom("your-email@example.com");

            helper.setTo(to);

            helper.setSubject(subject);

            helper.setText(content, true);

            mailSender.send(message);

        } catch (MessagingException e) {

            throw new EmailSendException("Failed to send HTML mail: " + e.getMessage());

        }

    }



    @Override

    public void sendAttachmentMail(String to, String subject, String content, String filePath) {

        try {

            MimeMessage message = mailSender.createMimeMessage();

            MimeMessageHelper helper = new MimeMessageHelper(message, true);

            helper.setFrom("your-email@example.com");

            helper.setTo(to);

            helper.setSubject(subject);

            helper.setText(content, true);

            File file = new File(filePath);

            helper.addAttachment(file.getName(), file);

            mailSender.send(message);

        } catch (MessagingException e) {

            throw new EmailSendException("Failed to send mail with attachment: " + e.getMessage());

        }

    }



    @Override

    public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId) {

        try {

            MimeMessage message = mailSender.createMimeMessage();

            MimeMessageHelper helper = new MimeMessageHelper(message, true);

            helper.setFrom("your-email@example.com");

            helper.setTo(to);

            helper.setSubject(subject);

            helper.setText(content, true);

            File file = new File(rscPath);

            helper.addInline(rscId, file);

            mailSender.send(message);

        } catch (MessagingException e) {

            throw new EmailSendException("Failed to send mail with inline resource: " + e.getMessage());

        }

    }

}

7.3 全局异常处理

我们可以通过创建全局异常处理类，来捕捉并处理自定义异常。

在src/main/java/com/example/email/exception目录下创建一个全局异常处理类GlobalExceptionHandler：


package com.example.email.exception;



import org.springframework.http.HttpStatus;

import org.springframework.http.ResponseEntity;

import org.springframework.web.bind.annotation.ExceptionHandler;

import org.springframework.web.bind.annotation.RestControllerAdvice;



@RestControllerAdvice

public class GlobalExceptionHandler {



    @ExceptionHandler(EmailSendException.class)

    public ResponseEntity<String> handleEmailSendException(EmailSendException ex) {

        return new ResponseEntity<>(ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);

    }

}

8. 测试邮件发送功能

8.1 使用Postman测试

  1. 确保Spring Boot应用已经启动。

  2. 使用Postman或其他类似工具，发送GET请求到如下URL：

    • 发送简单邮件：http://localhost:8080/mail/simple?to=recipient@example.com&subject=Test&content=Hello

    • 发送HTML邮件：http://localhost:8080/mail/html?to=recipient@example.com&subject=Test&content=

      Hello

    • 发送带附件的邮件：http://localhost:8080/mail/attachment?to=recipient@example.com&subject=Test&content=Hello&filePath=/path/to/file

    • 发送带内嵌资源的邮件：http://localhost:8080/mail/inline?to=recipient@example.com&subject=Test&content=Hello&rscPath=/path/to/image&rscId=rscId

8.2 单元测试

我们可以编写一些单元测试来确保邮件发送功能正常工作。在src/test/java/com/example/email/service目录下创建一个EmailServiceTest类。


package com.example.email.service;



import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.mail.javamail.JavaMailSender;



@SpringBootTest

public class EmailServiceTest {



    @Autowired

    private EmailService emailService;



    @Autowired

    private JavaMailSender mailSender;



    @Test

    public void testSendSimpleMail() {

        emailService.sendSimpleMail("recipient@example.com", "Test Subject", "Test Content");

    }



    @Test

    public void testSendHtmlMail() {

        emailService.sendHtmlMail("recipient@example.com", "Test Subject", "<h1>Test Content</h1>");

    }



    @Test

    public void testSendAttachmentMail() {

        emailService.sendAttachmentMail("recipient@example.com", "Test Subject", "Test Content", "path/to/file");

    }



    @Test

    public void testSendInlineResourceMail() {

        emailService.sendInlineResourceMail("recipient@example.com", "Test Subject", "Test Content<img src='cid:rscId'/>", "path/to/image", "rscId");

    }

}

9. 总结

通过本文，我们学习了如何使用Spring Boot 3来实现邮件服务功能。主要步骤包括：

  1. 创建Spring Boot项目，并添加相关依赖。

  2. 配置邮件发送的相关参数。

  3. 创建服务类来封装邮件发送逻辑。

  4. 使用控制器类来提供接口，实现邮件发送。

  5. 通过全局异常处理类来友好地处理异常。

  6. 使用Postman进行手动测试，以及编写单元测试来自动验证邮件功能。

一休哥助手
关注
  • 10
    点赞
  • 踩
  • 19
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Spring Boot 3.0 (十)：邮件服务
qq_2118119173的博客
08-14 284
邮件服务
springboot3——Email
hebtu666
10-22 3491
maven导入包： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> <version>2.1.6.RELEASE</version...
spring boot3整合邮件服务实现邮件发送功能
最新发布
蒾酒的博客
05-27 3876
本文介绍了spring boot整合email服务，实现发送验证码，邮件（普通文本邮件、静态资源邮件、附件邮件）这里以QQ邮箱为例，进入QQ邮箱官网，登录后点击设置，选择账号：，找到 POP3/IMAP.....服务这里开启你的服务，开通服务，依赖引入，配置属性，创建邮件发送工具类，测试。
SpringBoot整合(三)SpringBoot发送邮件
qq_44665283的博客
01-30 5046
SpringBoot发送邮件
SpringBoot3.x发送邮件
weixin_44800974的博客
09-08 552
JavaMailSender是Spring Boot在MailSenderPropertiesConfiguration类中配置好的，该类在Mail自动配置类MailSenderAutoConfiguration中导入，因此这里注入JavaMailSender就可以使用了。简单邮件可以直接构建一个SimpleMailMessage对象进行配置，配置完成后，通过JavaMailSender将邮件发送出去。传递的5个参数分别表示邮件发送者、收件人、抄送人、邮件主题以及邮件内容。
Spring Boot整合邮件发送并保存历史发送邮箱
12-31
Spring Boot整合邮件发送并保存历史发送邮箱 项目描述 项目主要是使用 Spring Boot 发送邮件，主要的技术点有： 1、Spring Boot +mybatis的整合 2、Spring Boot项目中jsp的使用 3、Spring Boot 发送邮件...
Spring Boot整合邮件发送与注意事项
08-27
主要给大家介绍了关于Spring Boot整合邮件发送与注意事项的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Spring boot搭建邮件服务的完整步骤
08-25
Spring Boot 提供了方便的集成方式来构建邮件服务，使得开发者能够快速搭建邮件发送系统。本文将详细介绍如何利用Spring Boot和EventBus来构建一个高效且灵活的邮件服务。 首先，我们要了解邮件服务的基本需求。...
Spring Boot Admin邮件警报整合过程解析
08-19
本文详细介绍了 Spring Boot Admin 邮件警报整合过程解析，通过示例代码和配置文件展示了如何使用 Spring Boot Admin 服务器发送预警邮件通知。该方法可以帮助开发者快速集成邮件警报功能，提高应用程序的可靠性和...
spring实现邮件发送功能+ssm+javamil
07-01
在本文中，我们将深入探讨如何使用Spring框架实现邮件发送功能，特别关注SSM（Spring、Spring MVC、MyBatis）和JavaMail的整合。对于初学者来说，这是一个基础且易于理解的教程，只需要遵循简单的步骤就能成功实现...
springboot集成javamail实现发送邮件功能
02-13
springboot集成javamail，实现发送邮件的功能，可以发送文本类型邮件，也可以发送html格式的邮件，其中整合了mysql、mybatis 具体集成步骤可以参考我的文章： https://www.jianshu.com/p/668d320b4981
SpringBoot三步实现邮件发送
zhangsann_6的博客
11-13 304
文章目录邮件发送1 导入依赖2 邮件发送配置3 具体代码4 测试 邮件发送 创建一个SpringBoot项目 1 导入依赖 <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </depende
SpringBoot发送Email
Csea的博客
09-16 521
1.POP3(Post Office Protocol 3) 　　POP3是Post Office Protocol 3的简称，即邮局协议的第3个版本,它规定怎样将个人计算机连接到Internet的邮件服务器和下载电子邮件的电子协议。它是因特网电子邮件的第一个离线协议标准,POP3允许用户从服务器上把邮件存储到本地主机（即自己的计算机）上,同时删除保存在邮件服务器上的邮件，而POP3服务器则是遵循...
Springboot（三）之邮件发送功能
qq_45425621的博客
04-27 238
SpringBoot 邮件发送功能 1.导入依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency> 2.配置yml文件 ...
Java技术：SpringBoot实现邮件发送功能
IT技术分享社区
04-12 6783
邮件发送功能基本是每个完整业务系统要集成的功能之一，今天小编给大家介绍一下SpringBoot实现邮件发送功能，希望对大家能有所帮助！今天主要给大家分享简单邮件发送、HTML邮件发送、包含附件的邮件发送三个例子，具体源码链接在文章末尾，有需要的朋友可以自己下载学习一下。1、创建一个基本的SpringBoot项目，pom文件导入发送邮件的依赖&......
Java Web 网络商城案例演示四、(向邮箱发送信息功能的实现)邮箱服务器的搭建，java Web发送邮件
2401_84153079的博客
04-12 938
整理面试题，不是让大家去只刷面试题，而是熟悉目前实际面试中常见的考察方式和知识点，做到心中有数，也可以用来自查及完善知识体系。《前端基础面试题》，《前端校招面试题精编解析大全》，《前端面试题宝典》，《前端面试题：常用算法》PDF完整版点击这里领取整理面试题，不是让大家去只刷面试题，而是熟悉目前实际面试中常见的考察方式和知识点，做到心中有数，也可以用来自查及完善知识体系。《前端基础面试题》，《前端校招面试题精编解析大全》，《前端面试题宝典》，《前端面试题：常用算法》PDF完整版点击这里领取。
springboot 3.x中，几行代码就可以优雅的发送邮件
xiaojun207的博客
12-31 473
springboot 3.x中，发送邮件非常的简单。只需一个配置，几行代码就可以搞定。
SpringBoot集成Mail功能
qq_15740267的博客
07-03 920
1. 邮件介绍 1.1 邮件的作用 邮件在项目中会经常用到,例如:注册,验证,找回密码,登录,信息通知 1.2 邮件协议 SMTP协议:       SMTP全称为Simple Mail Transfer Protocol（简单邮件传输协议），它是一组用于从源地址到目的地址传输邮件的规范，通过它来控制邮件的中转方式。SMTP认证要求必须提供账号和密码才能登陆服务器，其设计目的在于避免用户受到垃圾邮件的侵扰。 IMAP协议 :  &nbsp
SpringBoot整合ActiveMQ(消息中间件)实现邮件发送功能
05-25
好的，我可以为您提供一个简单的示例。 首先，您需要在SpringBoot项目中添加ActiveMQ的依赖。在pom.xml文件中添加以下代码： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-activemq</artifactId> </dependency> ``` 然后，您需要在application.properties文件中配置ActiveMQ的连接信息，如下所示： ```properties spring.activemq.broker-url=tcp://localhost:61616 spring.activemq.user=admin spring.activemq.password=admin ``` 接下来，您需要创建一个消息队列，用于存储要发送的邮件信息。在SpringBoot中，可以使用JmsTemplate来发送消息。您可以在您的Java代码中注入JmsTemplate，然后使用它来发送邮件消息。以下是一个示例代码： ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.jms.core.JmsTemplate; import org.springframework.stereotype.Service; @Service public class EmailService { @Autowired private JmsTemplate jmsTemplate; public void sendEmail(String to, String message) { jmsTemplate.convertAndSend("email.queue", new Email(to, message)); } } ``` 在上面的代码中，我们注入了JmsTemplate，并使用它来发送一个Email对象到名为“email.queue”的消息队列中。 最后，您需要编写一个消息监听器，用于监听邮件队列中的消息，并实现邮件发送逻辑。以下是一个示例代码： ```java import org.springframework.jms.annotation.JmsListener; import org.springframework.stereotype.Component; @Component public class EmailListener { @Autowired private JavaMailSender mailSender; @JmsListener(destination = "email.queue") public void sendEmail(Email email) { SimpleMailMessage message = new SimpleMailMessage(); message.setTo(email.getTo()); message.setSubject("Test Email"); message.setText(email.getMessage()); mailSender.send(message); } } ``` 在上面的代码中，我们使用@JmsListener注解来监听名为“email.queue”的消息队列中的消息，并实现了邮件发送逻辑。 最后，您需要确保ActiveMQ服务器已经启动，然后运行您的SpringBoot应用程序即可。 希望这个示例对您有帮助！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

一休哥助手

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值