SpringBoot 集成邮件服务

最新推荐文章于 2024-03-22 09:34:50 发布

码农新锐

最新推荐文章于 2024-03-22 09:34:50 发布

阅读量8.5k

点赞数 7

分类专栏： SpringBoot 文章标签：邮件服务 SpringBoot SMTP IMAP

本文链接：https://blog.csdn.net/qq_31984879/article/details/87516363

版权

SpringBoot 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

一、前言

1) 互联网发展到现在，相必大家都知道发送邮件应该是网站的必备功能之一:用户注册发送邮箱验证、忘记密码、监控提醒以及发送营销信息等。

2) Spring Email抽象的核心是MailSender接口，MailSender的实现能够把Email发送给邮件服务器，由邮件服务器实现邮件发送的功能。

早期发送邮件是通过Java自带的JavaMail类来发送邮件的，不过需要自己封装消息体，后来Spring推出了JavaMailSender类大大简化了发送邮件的过程，JavaMailSender继承自MailSender，提供了更强大的邮件发送功能，可支持不同类型的邮件发送。再到现在的Spring Boot又对其进行封装从而出现了spring-boot-starter-mail，进一步优化和完善邮件发送功能。

二、邮件协议

发送邮件的本质是将一个人的信息传输给另外一个人，那么如何传输就需要商量好标准，这些标准就是协议。最初只有两个协议：

SMTP 协议

SMTP 的全称是“Simple Mail Transfer Protocol”，即简单邮件传输协议。它是一组用于从源地址到目的地址传输邮件的规范，通过它来控制邮件的中转方式。SMTP 协议属于 TCP/IP 协议簇，它帮助每台计算机在发送或中转信件时找到下一个目的地。SMTP 服务器就是遵循 SMTP 协议的发送邮件服务器。
SMTP 认证，简单地说就是要求必须在提供了账户名和密码之后才可以登录 SMTP 服务器，这就使得那些垃圾邮件的散播者无可乘之机。增加 SMTP 认证的目的是为了使用户避免受到垃圾邮件的侵扰。

POP3 协议

POP3是Post Office Protocol 3的简称，即邮局协议的第3个版本,它规定怎样将个人计算机连接到Internet的邮件服务器和下载电子邮件的电子协议。它是因特网电子邮件的第一个离线协议标准,POP3允许用户从服务器上把邮件存储到本地主机（即自己的计算机）上,同时删除保存在邮件服务器上的邮件，而POP3服务器则是遵循POP3协议的接收邮件服务器，用来接收电子邮件的。但目前的 POP3 邮件服务器大都可以“只下载邮件，服务器端并不删除”，也就是改进的 POP3 协议。

SMTP 和 POP3 是最初的两个协议，随着邮件的不断发展后来又增加了两个协议：

IMAP 协议

IMAP全称是Internet Mail Access Protocol，即交互式邮件存取协议，它是跟POP3类似邮件访问标准协议之一。不同的是，开启了IMAP后，您在电子邮件客户端收取的邮件仍然保留在服务器上，同时在客户端上的操作都会反馈到服务器上，如：删除邮件，标记已读等，服务器上的邮件也会做相应的动作。所以无论从浏览器登录邮箱或者客户端软件登录邮箱，看到的邮件以及状态都是一致的。

Mime 协议

MIME的英文全称是"Multipurpose Internet Mail Extensions" 多功能Internet 邮件扩充服务，它是一种多用途网际邮件扩充协议，在1992年最早应用于电子邮件系统，但后来也应用到浏览器。MIME意为多目Internet邮件扩展，它设计的最初目的是为了在发送电子邮件时附加多媒体数据，让邮件客户程序能根据其类型进行处理。然而当它被HTTP协议支持之后，它的意义就更为显著了。它使得HTTP传输的不仅是普通的文本，而变得丰富多彩。

三、获取授权码

在使用前需要获取邮箱的授权码，用来发送邮件。

163邮箱步骤

163邮箱- > 设置 -> 邮箱安全设置 -> 客户端授权密码 -> 开启客户端授权码 -> 填写授权码

QQ邮箱步骤

QQ邮箱->设置->账户->POP3/SMTP服务:开启服务后会获得QQ的授权码。注：需要开通POP3和IMAP服务。

四、搭建步骤及简单使用

pom.xml文件

<!-- email依赖 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

配置文件

spring.mail.host=smtp.163.com
# 邮箱地址
spring.mail.username=****@qq.com
# 邮箱授权码
spring.mail.password=****
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.default-encoding=UTF-8

创建发送邮件Bean

public class MailBean implements Serializable {
    private static final long serialVersionUID = -2116367492649751914L;
    private String recipient;//邮件接收人
    private String subject; //邮件主题
    private String content; //邮件内容
    // 省略setget方法
}

文本邮件发送

Spring已经帮我们内置了JavaMailSender，直接在项目中引用即可。有了JavaMailSender，那么邮件发送就是一件再简单不过的事情了。我们只需要将JavaMailSender的Bean注入到我们自己的实现类中，然后使用JavaMail API来发送Email。

@Component
public class MailUtil {
    @Value("${spring.mail.username}")
    private String MAIL_SENDER; //邮件发送者

    @Autowired
    private JavaMailSender javaMailSender;

    private Logger logger = LoggerFactory.getLogger(MailUtil.class);

    /**
     * 发送文本邮件
     *
     * @param mailBean
     */
    public  void sendSimpleMail(MailBean mailBean) {
        try {
            SimpleMailMessage mailMessage= new SimpleMailMessage();
            mailMessage.setFrom(MAIL_SENDER);
            mailMessage.setTo(mailBean.getRecipient());
            mailMessage.setSubject(mailBean.getSubject());
            mailMessage.setText(mailBean.getContent());
            //mailMessage.copyTo(copyTo);

            javaMailSender.send(mailMessage);
        } catch (Exception e) {
            logger.error("邮件发送失败", e.getMessage());
        }
    }
}

其中：

from，即为邮件发送者，一般设置在配置文件中

to，邮件接收者，此参数可以为数组，同时发送多人

subject，邮件主题

content，邮件的主体

copyTo：抄送人

文本邮件测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootMailApplicationTests {

    @Autowired
    private MailUtil mailUtil;

    @Autowired
    private TemplateEngine templateEngine;

    //接收人
    private static final String RECIPINET = "****@163.com";

    /**
     * 发送文本邮件
     */
    @Test
    public void sendSimpleMail() {
        MailBean mailBean = new MailBean();
        mailBean.setRecipient(RECIPINET);
        mailBean.setSubject("SpringBootMail之这是一封文本的邮件");
        mailBean.setContent("SpringBootMail发送一个简单格式的邮件，时间为：" + DateUtils.format(new Date()));

        mailUtil.sendSimpleMail(mailBean);
    }

}

稍微等待几秒，就可以在邮箱中找到此邮件内容了。至此一个简单的文本邮件发送就完成了。

HTML格式邮件发送

与文本格式邮件代码对比，富文本HTML邮件发送使用MimeMessageHelper类，把setText()方法的消息文本设置为html,并将第二个参数设置为true,表示这是html的富文本。MimeMessageHelper支持发送复杂邮件模板，支持文本、附件、HTML、图片等。

public void sendHTMLMail(MailBean mailBean) {
    MimeMessage mimeMailMessage = null;
    try {
        mimeMailMessage = javaMailSender.createMimeMessage();
        //true 表示需要创建一个multipart message
        MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMailMessage, true);
        mimeMessageHelper.setFrom(MAIL_SENDER);
        mimeMessageHelper.setTo(mailBean.getRecipient());
        mimeMessageHelper.setSubject(mailBean.getSubject());
        //邮件抄送
        //mimeMessageHelper.addCc("抄送人");
        mimeMessageHelper.setText(mailBean.getContent(), true);
        javaMailSender.send(mimeMailMessage);
    } catch (Exception e) {
        logger.error("邮件发送失败", e.getMessage());
    }
}

HTML格式邮件测试类

@Test
public void sendHTMLMail() {
    MailBean mailBean = new MailBean();
    mailBean.setRecipient(RECIPINET);
    mailBean.setSubject("SpringBootMailHTML之这是一封HTML格式的邮件");
    StringBuilder sb = new StringBuilder();
    sb.append("<h2>SpirngBoot测试邮件HTML</h2>")
            .append("<p style='text-align:left'>这是一封HTML邮件...</p>")
            .append("<p> 时间为："+ DateUtils.format(new Date()) +"</p>");
    mailBean.setContent(sb.toString());

    mailUtil.sendHTMLMail(mailBean);
}

邮件内容写了一段话，下面为接收到的效果：

由此我们发现发送HTML邮件，就是需要拼接一段HTML的String字符串交给MimeMessageHelper来处理，最后由邮件客户端负责渲染显示内容。

附件格式邮件发送

发送附件需要用到FileSystemResource类对文件进行封装，再添加到MimeMessageHelper中。可以通过多个addAttachment方法发送多个附件,File.separator是用来分隔同一个路径字符串中的目录。

public void sendAttachmentMail(MailBean mailBean) {
    MimeMessage mimeMailMessage = null;
    try {
        mimeMailMessage = javaMailSender.createMimeMessage();
        //true 表示需要创建一个multipart message
        MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMailMessage, true);
        mimeMessageHelper.setFrom(MAIL_SENDER);
        mimeMessageHelper.setTo(mailBean.getRecipient());
        mimeMessageHelper.setSubject(mailBean.getSubject());
        mimeMessageHelper.setText(mailBean.getContent());
        //文件路径 目前写死在代码中，之后可以当参数传过来，或者在MailBean中添加属性absolutePath
        String absolutePath = "D:\\Program Files\\test.jpg";
        FileSystemResource file = new FileSystemResource(new File(absolutePath));
        //FileSystemResource file = new FileSystemResource(new File("src/main/resources/static/image/email.png"));
        String fileName = absolutePath.substring(absolutePath.lastIndexOf(File.separator));
        //添加附件,第一个参数表示添加到 Email 中附件的名称，第二个参数是图片资源
        mimeMessageHelper.addAttachment(fileName, file);
        //多个附件
        //mimeMessageHelper.addAttachment(fileName1, file1);

        javaMailSender.send(mimeMailMessage);
    } catch (Exception e) {
        logger.error("邮件发送失败", e.getMessage());
    }
}

测试邮件发送

@Test
public void sendAttachmentMail(){
    MailBean mailBean = new MailBean();
    mailBean.setRecipient(RECIPINET);
    mailBean.setSubject("SpringBootMail之这是一封有附件格式的邮件");
    mailBean.setContent("SpringBootMail发送一封有附件格式的邮件，时间为："+ DateUtils.format(new Date()));

    mailUtil.sendAttachmentMail(mailBean);

}

效果图如下：

静态资源格式邮件发送

邮件格式的静态资源，需要用到MimeMessageHelper中的addInline方法。需要注意的是：添加内联资源，一个id对应一个资源，最终通过id来找到该资源。即<img src='cid:"+ rscId + "' >和addInline(rscId,res)中的rscId要一致。同时要添加多个图片，可以使用多条<img src='cid:"+ rscId + "' >和addInline(rscId,res)来实现。

public void sendInlineMail(MailBean mailBean) {
    MimeMessage mimeMailMessage = null;
    try {
        mimeMailMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMailMessage, true);
        mimeMessageHelper.setFrom(MAIL_SENDER);
        mimeMessageHelper.setTo(mailBean.getRecipient());
        mimeMessageHelper.setSubject(mailBean.getSubject());
        mimeMessageHelper.setText(mailBean.getContent(), true);
        //文件路径
        String absolutePath = "D:\\Program Files\\email.png";
        FileSystemResource file = new FileSystemResource(new File(absolutePath));
        //FileSystemResource file = new FileSystemResource(new File("src/main/resources/static/image/email.png"))
        //添加多个图片可以使用多条 <img src='cid:" + rscId + "' > 和 mimeMessageHelper.addInline(rscId, res) 来实现
        mimeMessageHelper.addInline("picture", file);

        javaMailSender.send(mimeMailMessage);
    } catch (Exception e) {
        logger.error("邮件发送失败", e.getMessage());
    }
}

静态资源格式邮件发送

@Test
public void sendInlineMail() {
    MailBean mailBean = new MailBean();
    //id,目前写死了，可根据需要封装
    String rscId = "picture";
    String content="<html><body>这是有图片的邮件：<img src=\'cid:" + rscId + "\' ></body></html>";
    mailBean.setRecipient(RECIPINET);
    mailBean.setSubject("SpringBootMail之这是一封有静态资源格式的邮件");
    mailBean.setContent(content);

    mailUtil.sendInlineMail(mailBean);
}

结果如下：

邮件模板

上述介绍HTML格式的邮件不太优雅，修改起来也很不便，并且HTML硬编码在程序中。另外模板也适用于局部变化的内容，例如某云的邮件提示：

只需更改用户名和链接地址即可。

添加依赖：

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

创建email.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h3 th:text="|尊敬的${username} :|"></h3><br />
            <img src="http://gtms02.alicdn.com/tps/i2/T1YoblFq4cXXa94Hfd-32-32.png" /> 您有代金券即将到期，逾期失效，请尽早使用。<a th:href = "${url}" >点此查看</a>
            <br />
</body>
</html>

解析模板并发送

注意:Context类是在org.thymeleaf.context.Context包下的。process第一个参数名称要和templates下的模板页面视图名称一致，要不然会报错。

@Test
public void sendTemplate2Mail() {
    //注意：Context 类是在org.thymeleaf.context.Context包下的。
    Context context = new Context();
    //html中填充动态属性值
    context.setVariable("username", "码农用户");
    context.setVariable("url", "https://www.aliyun.com/?utm_content=se_1000301881");
    //注意：process第一个参数名称要和templates下的模板名称一致。要不然会报错
    //org.thymeleaf.exceptions.TemplateInputException: Error resolving template [email]
    String emailContent = templateEngine.process("email", context);

    MailBean mailBean = new MailBean();
    mailBean.setRecipient(RECIPINET);
    mailBean.setSubject("主题：这是模板邮件");
    mailBean.setContent(emailContent);

    mailUtil.sendHTMLMail(mailBean);
}

结果：

常见问题

错误码	错误描述	解决方案
550	用户权限不足550 User has no permission。	启动163客户端授权码，上文有对此的开通步骤。
535	认证错误535 Error: authentication failed。	使用开通smtp服务后的授权码作为登录密码。
554	发送内容错误554 DT:SPM。即：发送的邮件内容包含了未被许可的信息，或被系统识别为垃圾邮件。	请检查是否有用户发送病毒或者垃圾邮件；修改邮件的主题及内容，使用合法信息。
451	登录失败次数过多，被临时禁止登录too much fail authentication。	请检查密码与帐号验证设置。
静态邮件图片无法显示	发送静态图片资源，查看邮件，图片显示不出来。	addInline()方法第一个参数要和html中的cid的值保持一致。
Error resolving template [email]	org.thymeleaf.exceptions.TemplateInputException: Error resolving template [email]。	process方法第一个参数名称要和templates下的模板视图名称要一致。

五、总结

使用 Spring Boot 集成发送邮件的功能非常简单，只需要简单编码就可以实现发送普通文本邮件、带附件邮件、HTML 格式邮件、带图片邮件等。

如果需要做成一个邮件系统还需要考虑很多因素，比如：邮箱发送失败重试机制、防止邮件被识别为垃圾邮件，固定时间内发送邮件的限制等。

在微服务架构中，常常将一些基础功能下沉下来，作为独立的服务来使用，邮件系统作为平台的基础功能，特别适合做为独立的微服务来支持整个系统。

本文中代码：

https://github.com/xiaonongOne/springboot-mail/

码农新锐

关注

7
点赞
踩
29

收藏

觉得还不错? 一键收藏
1
评论
SpringBoot 集成邮件服务

一、前言1) 互联网发展到现在，相必大家都知道发送邮件应该是网站的必备功能之一:用户注册发送邮箱验证、忘记密码、监控提醒以及发送营销信息等。2) Spring Email抽象的核心是MailSender接口，MailSender的实现能够把Email发送给邮件服务器，由邮件服务器实现邮件发送的功能。 ...
复制链接

扫一扫