Spring Email发送邮件的深入学习与使用

已于 2022-01-19 14:52:50 修改
阅读量8.9k 收藏 31
点赞数 9
分类专栏： Spring 5.x 学习 文章标签： spring email spring发送邮件 spring
于 2021-01-16 19:52:45 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43767015/article/details/112723478
版权

  详细介绍了使用Spring 快速发送邮件的方法。

  此前我们发送邮件，需要使用JavaMail提供的API来编程：Java EE网络基础(10)—使用JavaMail收发Email电子邮件。Spring Framework 提供了一个实用的程序库，用于发送电子邮件，让程序员免受底层邮件系统细节的影响，并负责代表客户端进行低级资源处理。

文章目录

1 Spring Email的概述

  org.springframework.mail 包是 Spring Framework电子邮件支持的总包。发送电子邮件的中心接口是 MailSender 接口，org.springframework.mail.javamail.JavaMailSender接口继承并扩展了MailSender接口，作为邮件发送器，主要提供了邮件发送接口、透明创建Java Mail的MimeMessage、及邮件发送的配置(如:host/port/username/password…)，我通常使用它的实现类JavaMailSenderImpl。
  SimpleMailMessage类是一个简单的值对象，它实现了javaMail的MailMessage，支持封装简单的邮件的属性，比如from和to等属性。此包还包含一系列的受检异常，这些异常是在较低级别的邮件系统异常上提供的更高级别的抽象，而根异常是 MailException。
  通常使用org.springframework.mail.javamail.MimeMessageHelper方便的创建 JavaMail 的MimeMessage，可用于支持一些复杂的邮件内容，比如发送一些附件、嵌入图片资源等。
  Spring的JavaMail的API数据Spring Framework的扩展，它位于spring-context-support依赖中，而Spring的API又依赖于sun公司提供的底层JavaMail的API，因此我们至少需要两个依赖：

    <properties>
        <spring-framework.version>5.2.8.RELEASE</spring-framework.version>
        <javax.mail.version>1.6.2</javax.mail.version>
        <junit>4.12</junit>
    </properties>
    <dependencies>
        <!--spring 核心组件所需依赖-->
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-context-support -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring-framework.version}</version>
        </dependency>
        <!--sun JavaMail 依赖-->
        <!-- https://mvnrepository.com/artifact/com.sun.mail/javax.mail -->
        <dependency>
            <groupId>com.sun.mail</groupId>
            <artifactId>javax.mail</artifactId>
            <version>${javax.mail.version}</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-test -->
        <!--Spring 测试-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${spring-framework.version}</version>
        </dependency>
        <!--单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit}</version>
        </dependency>
    </dependencies>

2 发送简单邮件

  基础的MailSender 和 SimpleMailMessage的API足以支持发送大部分简单的文本的电子邮件！

2.1 配置

  Spring的对于通用组件类都支持配置式管理，而不需要我们手动创建，因此对于JavaMailSenderImpl和SimpleMailMessage都可以采用配置的方式，把对象的创建交给Spring管理。JavaMailSenderImpl用于发送邮件，是线程安全的，而SimpleMailMessage主要用作一个邮件模版，在使用时，需要使用自己拷贝的对象，否则如果多个线程一起使用，则可能导致线程不安全！
  基于XML的配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">


    <context:property-placeholder location="mail.properties"/>

    <!--配置JavaMailSenderImpl-->
    <bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
        <!--设置邮件服务器主机-->
        <property name="host" value="${mail.sender.host}"/>
        <!--端口号-->
        <property name="port" value="${mail.sender.port}"/>
        <!--用户名-->
        <property name="username" value="${mail.sender.username}"/>
        <!--密码或者授权码-->
        <property name="password" value="${mail.sender.password}"/>
        <!--设置其他属性-->
        <property name="javaMailProperties">
            <props>
                <!--是否需要认证-->
                <prop key="mail.smtp.auth">${mail.sender.auth}</prop>
            </props>
        </property>
    </bean>

    <!--配置一个模版消息，也可以在代码中创建消息-->
    <bean id="templateMessage" class="org.springframework.mail.SimpleMailMessage">
        <!--设置发件人-->
        <property name="from" value="${mail.message.from}"/>
        <!--设置收信人，可以通过传递参数数组设置多个，这里只设置一个-->
        <property name="to" value="${mail.message.to}"/>
        <!--设置抄送人，可以通过传递参数数组设置多个，这里只设置一个-->
        <property name="cc" value="${mail.message.cc}"/>
        <!--设置暗送人，可以通过传递参数数组设置多个，这里只设置一个-->
        <property name="bcc" value="${mail.message.bcc}"/>
        <!--设置邮件主题-->
        <property name="subject" value="${mail.message.subject}"/>
    </bean>

</beans>

  基于@Bean注解的JavaConfig配置更简单，这里不再赘述。
  mail.properties配置文件：

# 邮件服务器主机，这里选择163邮箱
mail.sender.host=smtp.163.com
# smtp端口号默认就是25
mail.sender.port=25
# 是否需要认证
mail.sender.auth=true
# 用户名
mail.sender.username=xx@163.com
# 密码或者授权码，某些邮箱可能需要开启smtp功能
mail.sender.password=xx


# 发件人
mail.message.from=xx@163.com
# 收件人
mail.message.to=xx@qq.com
# 抄送人
mail.message.cc=xx@yeah.net
# 暗送人
mail.message.bcc=xx@ikang.com
# 主题，这个可以在代码中配置
mail.message.subject=Spring Email

2.2 测试

  这里使用Spring test来执行测试：

/**
 * @author lx
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:spring-mail.xml")
public class EmailTest {

    /*
     * 在开发中，这些这些可以直接注入到组件类中
     */

    @Resource
    private MailSender mailSender;
    @Resource
    private SimpleMailMessage templateMessage;


    @Test
    public void simpleEmailTest() {
        sendEmail("这是一封Spring发送的电子邮件!");
    }

    private void sendEmail(String test) {
        //根据模版创建一个线程安全的拷贝对象，并对其进行自定义属性
        SimpleMailMessage msg = new SimpleMailMessage(this.templateMessage);
        //设置正文文本
        msg.setText(test);
        //发送邮件
        mailSender.send(msg);
    }
}

3 发送复杂邮件

  使用 JavaMailSender 和 JavaMail的MimeMesage 以创建更复杂的邮件，例如带有附件的邮件、特殊字符编码或HTML文本等。

3.1 使用MimeMessagePreparator

  Spring提供了MimeMessagePreparator回调接口，它有一个prepare方法用于准备JavaMail的MIME信件。
  发送一封HTML邮件！

/**
 * @author lx
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:spring-mail.xml")
public class MimeMessagePreparatorTest {

    /*
     * 在开发中，这些这些可以直接注入到组件类中
     */

    @Resource
    private JavaMailSender mailSender;

    @Value("${mail.message.from}")
    private String from;
    @Value("${mail.message.to}")
    private String to;
    @Value("${mail.message.cc}")
    private String cc;
    @Value("${mail.message.bcc}")
    private String bcc;


    @Test
    public void emailTest() {
        sendEmail();
    }

    private void sendEmail() {
        MimeMessagePreparator mimeMessagePreparator = mimeMessage -> {
            //设置发信人
            mimeMessage.setFrom(new InternetAddress(from));
            //设置收信人，可以设置多个，采用参数数组或者","分隔
            mimeMessage.addRecipients(TO, to);
            //设置抄送人，可以设置多个，采用参数数组或者","分隔
            mimeMessage.addRecipients(CC, cc);
            //设置暗送人，可以设置多个，采用参数数组或者","分隔
            mimeMessage.addRecipients(BCC, bcc);
            //设置邮件主题（标题）
            mimeMessage.setSubject("mimeMessagePreparator的HTML邮件");
            //设置邮件内容（正文）和类型
            mimeMessage.setContent("<h2><font color=red>2021加油哦!</font></h2>", "text/html;charset =utf-8");
        };
        mailSender.send(mimeMessagePreparator);
    }
}

3.2 使用MimeMessageHelper

  大部分电子邮件允许附件和内嵌资源。内嵌资源包括要在邮件中使用但不希望显示为附件的图像或样式表格。
  可以看到，上面的MimeMessagePreparator仍然是采用了JavaMail的mimeMessage构建消息，mimeMessage的原始API用来处理内联消息或者附件将会比较复杂，此时可以使用Spring提供的 org.springframe.mail.javamail.MimeMessageHelper，它保护您不必使用冗长的 JavaMail API。使用 MimeMessageHelper创建复杂的 MimeMessage 非常简单！
  简单的使用如下：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:spring-mail.xml")
public class MimeMessageHelperTest {

    @Resource
    private JavaMailSender mailSender;

    @Value("${mail.message.from}")
    private String from;
    @Value("${mail.message.to}")
    private String to;
    @Value("${mail.message.cc}")
    private String cc;
    @Value("${mail.message.bcc}")
    private String bcc;

    @Test
    public void emailTest() throws MessagingException {

        MimeMessage mimeMessage = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage);
        helper.setFrom(from);
        helper.setTo(to);
        helper.setCc(cc);
        helper.setBcc(bcc);
        helper.setSubject("MimeMessageHelper测试!");
        helper.setText("MimeMessageHelper测试!");
        mailSender.send(mimeMessage);
    }
}

3.2.1 发送附件

@Test
public void attachmentsTest() throws MessagingException {
    MimeMessage mimeMessage = mailSender.createMimeMessage();
    //使用 true 标志位表示需要使用多部分消息，即multipart
    MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
    //设置基本属性
    helper.setFrom(from);
    helper.setTo(to);
    helper.setCc(cc);
    helper.setBcc(bcc);
    helper.setSubject("MimeMessageHelper附件测试!");
    //设置正文
    helper.setText("MimeMessageHelper附件!");

    /*
     * 添加图片附件
     * 相对路径必须找正确
     * 如果不知道路径，那么可以先通过File测试，找到绝对路径前缀，然后再传递相对路径
     * File file = new File("");
     * System.out.println(file.getAbsolutePath());
     */

    //附件图片
    FileSystemResource fileSystemResource = new FileSystemResource("src/main/resources/pic.jpg");

    //添加附件名和附件输入流
    helper.addAttachment("pic.jpg", fileSystemResource);

    /*
     * 发送
     */
    mailSender.send(mimeMessage);
}

  结果如下：
在这里插入图片描述

3.2.2 发送内嵌资源

  使用addInline方法使用指定的的Content-ID将内嵌资源添加到 MimeMessage 中。
  添加文本和资源的顺序非常重要。请务必先添加文本，然后添加资源。如果顺序相反，那么不会工作。

@Test
public void inlineResourcesTest() throws MessagingException {
    MimeMessage mimeMessage = mailSender.createMimeMessage();
    /*
     * 第二个参数 true 标志位，表示需要使用多部分消息，即multipart
     * 第三个参数 encoding，表示设置消息编码的格式
     */
    MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true, "utf-8");
    /*
     * 设置基本属性
     */
    helper.setFrom(from);
    helper.setTo(to);
    helper.setCc(cc);
    helper.setBcc(bcc);
    helper.setSubject("MimeMessageHelper的内嵌图片测试");

    /*
     * 设置正文
     *
     * 第二个参数 true 标志位，表示设置正文为HTML格式
     * 其中的图片采用<img src='cid:pic'/>形式，指定需要内嵌的图片的Content-ID
     */
    helper.setText("<html><body><h4><font color='red'>这是一张内嵌图片</font>" +
                    "</h4><img src='cid:pic'/></body></html>",true);

    /*
     * 添加图片附件
     *
     * 相对路径必须找正确
     * 如果不知道路径，那么可以先通过File测试，找到绝对路径前缀，然后再传递相对路径
     * File file = new File("");
     * System.out.println(file.getAbsolutePath());
     */

    //附件图片
    FileSystemResource fileSystemResource = new FileSystemResource("src/main/resources/pic.jpg");

    //添加内嵌图片关联的html的Content-ID，即pic
    helper.addInline("pic", fileSystemResource);

    /*
     * 发送
     */
    mailSender.send(mimeMessage);
}

  结果如下：
在这里插入图片描述

4 总结

  Spring提供的发送email的API大大的简化了开发人员发送邮件所需编写的JavaMail代码。另外，在上面的案例中，我们是直接设置的正文，在实际上企业开发中，通常不会这样显示的创建邮件内容：

  1. 在 Java 代码中创建基于 HTML 的电子邮件内容既繁琐又容易出错。
  2. 显示逻辑和业务逻辑之间没有明确的分离。
  3. 更改电子邮件内容的显示结构需要编写 Java 代码、重新编译、重新部署等。

  通常，解决这些问题的方法是使用邮件内容模板（如 FreeMarker、HTML文件）来定义电子邮件内容的显示结构。这样代码的任务只是将要在电子邮件模板中呈现的数据填充到模版中并发送电子邮件。当电子邮件的内容变得比较复杂时，这绝对是一个最佳实践。

如有需要交流，或者文章有误，请直接留言。另外希望点赞、收藏、关注，我将不间断更新各种Java学习博客！

刘Java
关注
  • 9
    点赞
  • 踩
  • 31
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
spring email讲解
永不止步--Roger*Come On
06-02 2975
6. email6.1介绍spring 框架提供了一个发送邮箱的实用库，这样就可以让避免让开发者更深层次地了解邮箱系统而带来的开发效率问题。org.springframework.mail 包提供了spring框架邮箱的底层支持。发邮件的核心接口为MailSender接口；SimpleMailMessage是一个封装了简单邮件的发送和接收功能的简单类。该包也同样包含了检测异常模块，该模块基于Mai...
spring mail的使用
04-09
NULL 博文链接：https://wangshiyang.iteye.com/blog/1625411
spring mail 实例
07-30
NULL 博文链接：https://wellfrog.iteye.com/blog/834337
推荐使用：Mailspring Theme Starter - 定制你的专属邮件客户端主题
最新发布
gitblog_00054的博客
05-30 371
推荐使用：Mailspring Theme Starter - 定制你的专属邮件客户端主题 项目地址:https://gitcode.com/Foundry376/Mailspring-Theme-Starter 项目介绍 Mailspring Theme Starter 是一个专为 Mailspring 邮件客户端设计的起点工具，它让你轻松创建独一无二的主题，赋予你的邮件收发环境个性化的色彩。这...
SpringBoot项目发送邮件&邮箱配置
qq_56610467的博客
06-26 1441
配置，这里展示的是网易邮箱，任何邮箱都是需要配置此处，可以自行查找配置。使用邮箱发送需要自行手动开通邮箱的。
Spring-Mail
qq_41878423的博客
04-28 3188
Spring-Mail基本了解发送纯文本邮件发送HTML邮件发送内嵌资源的邮件发送带附件的邮件 基本了解 spring为发送邮件提供了一个抽象层: 定义了MailMessage 和 MailSender抽象 来描述邮件消息和邮件发送者 # 消息 MailMessage: 有两个实现类: SimpleMainMessage(text格式) 和 MimeMailMessage(多用途) setTo(String to) 发送地址，可以设置多个 setFrom(String from) 发送方 setCc(St
Spring 发送Email
书香水墨
08-25 4323
一、配置Spring发送邮件 Spring Email抽象的核心是MailSender接口。顾名思义，MailSender的实现能够通过连接Email服务器实现邮件发送的功能，如图所示： Spring自带了一个MailSender的实现也就是JavaMailSenderImpl，它会使用JavaMail API来发送Email。Spring应用在发送Email之前，我们必须要将JavaMail...
Spring Boot 发送邮件全解析
woliuqiangdong的博客
11-06 4002
1.前言 今天我们就来学一下如何在Spring Boot下发送电子邮件。 2. 依赖 Java 发送邮件依赖jakarta项目（原javaEE）提供的jakarta.mail组件,Maven坐标： <dependency> <groupId>com.sun.mail</groupId> <artifactId>jakarta.mail</artifactId> ...
Spring和Email整合详解
feiyangtianyao的专栏
01-24 6635
Spring和Email详解 官方主页 Spring Email 概述 Spring Mail API都在org.springframework.mail及其子包org.springframework.mail.javamail中封装。 JavaMailSenderImpl: 邮件发送器，主要提供了邮件发送接口、透明创建Java Mail的MimeMessage、及邮件发送的配置(如:host/p...
一个用于深入学习并实战Spring Boot的项目
12-27
spring boot demo是一个用于深度学习并实战...强大的ORM框架)、upload( 本地文件上传和七牛云文件上传)、redis( 缓存)、ehcache( 缓存)、email( 发送各种类型邮件)、task( 基础定时任务)、quartz( 动态管理定时任务)等
使用springMail发送带附件的email
03-06
通过参考该项目，我们可以深入学习如何利用Spring框架来集成邮件服务，发送包含文本、HTML内容以及附件的邮件。 首先，我们需要在项目中引入SpringMail的依赖。通常，这可以通过Maven或Gradle的配置来完成。例如，...
Spring邮件发送
04-02
NULL 博文链接：https://nassir.iteye.com/blog/1455294
自己开发的JAVA Web Email邮件系统
06-29
【标签】：“JAVA Email”指的是使用JAVA语言处理电子邮件的程序设计，这可能涉及到JavaMail API，这是一个开源库，为开发者提供了处理邮件的标准API，可以实现邮件的发送、接收和解析。邮件客户端则是用户与邮件...
从零开始java邮件篇篇：spring Mail实现邮件发送
qq_35755863的博客
09-22 1208
一：邮件发送 毋庸置疑，在一个企业级的管理后台中，企业发送邮件是必要的的。在没有spring Mail之前，javaMail发送邮件的步骤是繁琐的。后来spring整合了相关的Mail之后，其API接口方式就变得很简单了。其实springboot2.x版本整合spring Mail还是很简单的。这里主要还是说明一下一些具体逻辑的处理： 关于下面的三个箭头，我想就不用说明了吧，其实很...
使用Spring Boot发送邮件
热门推荐
打工仔的博客
07-30 2万+
pom 包配置 &amp;amp;amp;amp;amp;amp;amp;amp;amp;lt;dependency&amp;amp;amp;amp;amp;amp;amp;amp;amp;gt; &amp;amp;amp;amp;amp;amp;amp;amp;amp;lt;groupId&amp;amp;amp;amp;amp;amp;amp;amp;amp;gt;org.springframework.boot&amp;amp;amp;amp;amp;a
Spring Mail 集成
u011846818的专栏
04-20 1182
Spring对mail功能的集成。
spring框架使用JavaMailSenderImpl发送邮件
kkkyyyoo的博客
04-11 400
1.需要mail-1.4.1.jar包，编写applicationContext-email.xml文件 <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.s
Spring Email使用
fxtxz2的专栏
08-21 336
场景 通过Spring发邮件，这里借用第三方smtp邮件服务器 pom.xml <!-- send email --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency> applicat
spring-mail
qq_42001135的博客
08-05 176
添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency> application.properties配置 #-------------邮件---------------- spring.m
spring boot 发送邮件
07-27
你可以使用 Spring Boot 的邮件发送功能来发送电子邮件。首先，你需要在项目的依赖中添加 Spring Boot 的邮件依赖。在 `pom.xml` 文件中添加以下代码： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency> ``` 接下来，你需要在配置文件中配置邮件相关的属性。在 `application.properties`（或 `application.yml`）文件中添加以下属性： ```properties # 邮件服务器主机名 spring.mail.host=your-mail-host # 邮件服务器端口 spring.mail.port=your-mail-port # 邮件发送者用户名 spring.mail.username=your-username # 邮件发送者密码 spring.mail.password=your-password # 邮件发送者地址 spring.mail.from=your-email-address ``` 现在，你可以在你的代码中使用 `JavaMailSender` 接口来发送邮件。你可以注入 `JavaMailSender` 接口的实例，并使用 `send()` 方法发送邮件。以下是一个简单的示例： ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.mail.SimpleMailMessage; import org.springframework.mail.javamail.JavaMailSender; import org.springframework.stereotype.Service; @Service public class EmailService { @Autowired private JavaMailSender javaMailSender; public void sendEmail(String to, String subject, String text) { SimpleMailMessage message = new SimpleMailMessage(); message.setTo(to); message.setSubject(subject); message.setText(text); javaMailSender.send(message); } } ``` 你可以在需要发送邮件的地方调用 `sendEmail()` 方法，并传入收件人地址、邮件主题和邮件内容。 这是使用 Spring Boot 发送邮件的基本步骤。你可以根据自己的需求进行进一步的定制和配置。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

刘Java

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

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

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

打赏作者

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

抵扣说明：

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

余额充值