Springboot（十）：邮件服务

最新推荐文章于 2022-11-03 00:54:21 发布

转载最新推荐文章于 2022-11-03 00:54:21 发布 · 1.1k 阅读

spring-boot 同时被 2 个专栏收录

12 篇文章

订阅专栏

邮件服务

1 篇文章

订阅专栏

本文详细介绍了使用SpringBoot发送各种类型邮件的方法，包括文本、HTML、带附件和静态资源的邮件，以及邮件模板的创建与使用。通过示例代码演示了如何配置邮件服务，处理邮件发送过程中的常见问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

发送邮件应该是网站的必备功能之一，什么注册验证，忘记密码或者是给用户发送营销信息。最早期的时候我们会使用javaMail相关api来写邮件相关代码，后来spring退出了javaMailSender 更加简化了邮件发送的过程，在之后springboot 对此进行了封装就有了现在的spring-boot-starter-mail，本章文章的介绍主要来自于此包。

简单使用

1、pom包配置

pom包里添加spring-boot-starter-mail包引用

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

2、在application.properties中添加邮箱配置

spring.mail.host=smtp.qiye.163.com //邮箱服务器地址
spring.mail.username=xxx@oo.com //用户名
spring.mail.password=xxyyooo    //密码
spring.mail.default-encoding=UTF-8

mail.fromMail.addr=xxx@oo.com  //以谁来发送邮件

3、编写mailService，这里只提出实现类。

@Component
public class MailServiceImpl implements MailService{

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired
    private JavaMailSender mailSender;

    @Value("${mail.fromMail.addr}")
    private String from;

    @Override
    public void sendSimpleMail(String to, String subject, String content) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setFrom(from);
        message.setTo(to);
        message.setSubject(subject);
        message.setText(content);

        try {
            mailSender.send(message);
            logger.info("简单邮件已经发送。");
        } catch (Exception e) {
            logger.error("发送简单邮件时发生异常！", e);
        }
    }
}

4、测试

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

    @Autowired
    private MailService MailService;

    @Test
    public void testSimpleMail() throws Exception {
        MailService.sendSimpleMail("ityouknow@126.com","test simple mail"," hello this is simple mail");
    }
}

至此一个简单的文本发送就完成了。

在使用过程中出现的问题问题

如果使用163邮箱要先打开POP3等服务：163邮箱如何开启POP3/SMTP/IMAP服务？
535：springboot 发送邮件报535错误解决办法
注意引用application.properties中的属性是这样的@Value("${mail.fromMail.addr}")，不要少了${}
javamail发送的邮件被qq放到垃圾箱里面去了（不要含有测试等一些不重要的词）

加点料

在使用过程中，我们通常在邮件中加入图片或者附件来丰富邮件的内容，下面将介绍使用springboot来发送丰富的邮件。

发送html格式邮件

其他都不变在MailService添加sendHtmlMail方法。

public void sendHtmlMail(String to, String subject, String content) {
    MimeMessage message = mailSender.createMimeMessage();

    try {
        //true表示需要创建一个multipart message
        MimeMessageHelper helper = new MimeMessageHelper(message, true);
        helper.setFrom(from);
        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(content, true);

        mailSender.send(message);
        logger.info("html邮件发送成功");
    } catch (MessagingException e) {
        logger.error("发送html邮件时发生异常！", e);
    }
}

在测试类中构建html内容，测试发送

@Test
public void testHtmlMail() throws Exception {
    String content="<html>\n" +
            "<body>\n" +
            "    <h3>hello world ! 这是一封Html邮件!</h3>\n" +
            "</body>\n" +
            "</html>";
    MailService.sendHtmlMail("ityouknow@126.com","test simple mail",content);
}

发送带附件的邮件

在MailService添加sendAttachmentsMail方法。

public void sendAttachmentsMail(String to, String subject, String content, String filePath){
    MimeMessage message = mailSender.createMimeMessage();
    try {
        MimeMessageHelper helper = new MimeMessageHelper(message, true);
        helper.setFrom(from);
        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(content, true);

        FileSystemResource file = new FileSystemResource(new File(filePath));
        String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
        helper.addAttachment(fileName, file);

        mailSender.send(message);
        logger.info("带附件的邮件已经发送。");
    } catch (MessagingException e) {
        logger.error("发送带附件的邮件时发生异常！", e);
    }
}

发送带静态资源的邮件

邮件中的静态资源一般就是指图片，在MailService 添加 sendInlineResourceMail 方法。

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(from);
        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(content, true);

        FileSystemResource res = new FileSystemResource(new File(rscPath));
        helper.addInline(rscId, res);

        mailSender.send(message);
        logger.info("嵌入静态资源的邮件已经发送。");
    } catch (MessagingException e) {
        logger.error("发送嵌入静态资源的邮件时发生异常！", e);
    }
}

上面的helper.addInline(rscId, res);使recId和res内联在一起。
在测试方法中添加测试方法

@Test
public void sendInlineResourceMail() {
    String rscId = "neo006";
    String content="<html><body>这是有图片的邮件：<img src=\'cid:" + rscId + "\' ></body></html>";
    String imgPath = "C:\\Users\\summer\\Pictures\\favicon.png";

    mailService.sendInlineResourceMail("ityouknow@126.com", "主题：这是有图片的邮件", content, imgPath, rscId);
}

添加多个图片可以使用多条<img src='cid:" + rscId + "' > 和 helper.addInline(rscId, res) 来实现。

到此所有的邮件发送服务已经完成了。

邮件系统

邮件模板

我们会经常收到这样的邮件：

尊敬的neo用户：
恭喜您注册成为xxx网的用户,，同时感谢您对xxx的关注与支持并欢迎您使用xx的产品与服务。
…

其中只有neo这个用户名在变化，其他邮件内容均不变，如果每次发送邮件都需要手动拼接的话不够优雅，并且每次模板的修改都需要改动也很不方便，因此对于这类邮件的需求，建议做成模板来处理。
模板的本质很简单，就是在模板中替换变化的参数，转换为html字符串即可，这里以thymeleaf为例。

1、pom包导入thymeleaf

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

2、在resorces/templates 下创建emailTemplate.html

<!DOCTYPE html>
<html lang="zh" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8"/>
        <title>Title</title>
    </head>
    <body>
        您好,这是验证邮件,请点击下面的链接完成验证,<br/>
        <a href="#" th:href="@{ http://www.ityouknow.com/neo/{id}(id=${id}) }">激活账号</a>
    </body>
</html>

{id}(id=${id}) 这里一个参数就传入了。

3、解析模板并发送

@Test
public void sendTemplateMail() {
    //创建邮件正文
    Context context = new Context();
    context.setVariable("id", "006");
    String emailContent = templateEngine.process("emailTemplate", context);
    mailService.sendHtmlMail("ityouknow@126.com","主题：这是模板邮件",emailContent);
}