SpringBoot2 使用 JavaMailSender

JavaMailSender

        相信使用过Spring的众多开发者都知道Spring提供了非常好用的JavaMailSender接口实现邮件发送。在Spring Boot的Starter模块中也为此提供了自动化配置。下面通过实例看看如何在Spring Boot中使用JavaMailSender发送邮件。


快速入门

在Spring Boot的工程中的pom.xml中引入spring-boot-starter-mail依赖:

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

如其他自动化配置模块一样,在完成了依赖引入之后,只需要在application.yml中配置相应的属性内容

下面我们以QQ邮箱为例,在application.yml中加入如下配置(注意替换自己的用户名和密码):

spring:
  mail:
    host: smtp.qq.com
    username: [email protected]
    password: your-password

通过单元测试来实现一封简单邮件的发送:

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

    // 获取JavaMailSender bean
    @Autowired
    private JavaMailSender javaMailSender;

    // 获取配置文件的username
    @Value("${spring.mail.username}")
    private String username;

    /**
     * 一个简单的邮件发送
     */
    @Test
    public void sendSimpleMail1(){
        SimpleMailMessage message = new SimpleMailMessage();
           // 设定邮件参数
           message.setFrom(username); //发送者
           message.setTo("[email protected]"); //接受者
           message.setSubject("主题:邮件"); //主题
           message.setText("邮件内容"); //邮件内容

           // 发送邮件
           javaMailSender.send(message);
    }
}

到这里,一个简单的邮件发送就完成了,运行一下该单元测试,看看效果如何?


进阶使用

在上例中,我们通过使用SimpleMailMessage实现了简单的邮件发送,但是实际使用过程中,我们还可能会带上附件、或是使用邮件模块等。这个时候我们就需要使用MimeMessage来设置复杂一些的邮件内容,下面我们就来依次实现一下。

发送附件

在上面单元测试中加入如下测试用例(通过MimeMessageHelper来发送一封带有附件的邮件):

/**
     * 发送html格式并带附件
     */
    @Test
    public void sendSimpleMail3() throws MessagingException {
        MimeMessage mimeMessage = javaMailSender.createMimeMessage();

        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
        helper.setFrom(username);
        helper.setTo("[email protected]");
        helper.setSubject("主题:嵌入静态资源");
        // 注意<img/>标签,src='cid:jpg','cid'是contentId的缩写,'jpg'是一个标记
        helper.setText("<html><body><img src=\"cid:jpg\"></body></html>", true);
        // 加载文件资源,作为附件
        FileSystemResource file = new FileSystemResource(new File("F:/test/2.jpg"));
        // 调用MimeMessageHelper的addInline方法替代成文件('jpg[标记]', file[文件])
        helper.addInline("jpg", file);

        // 发送邮件
        javaMailSender.send(mimeMessage);
    }

这里需要注意的是addInline函数中资源名称jpg需要与正文中cid:jpg对应起来



嵌入静态资源

除了发送附件之外,我们在邮件内容中可能希望通过嵌入图片等静态资源,让邮件获得更好的阅读体验,而不是从附件中查看具体图片,下面的测试用例演示了如何通过MimeMessageHelper实现在邮件正文中嵌入静态资源。

/**
     * 发送html格式Email
     */
    @Test
    public void sendSimpleMail2() throws MessagingException, UnsupportedEncodingException {
        //使用JavaMail的MimeMessage,支付更加复杂的邮件格式和内容
        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        //创建MimeMessageHelper对象,处理MimeMessage的辅助类
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
        //使用辅助类MimeMessage设定参数
        helper.setFrom(new InternetAddress(username, "Ray", "UTF-8"));
        helper.setTo("[email protected]");
        helper.setSubject("主题:HTML格式");
        StringBuffer stringBuffer = new StringBuffer();
        stringBuffer
                .append("<html><body>")
                .append("<h1>Hello! Ray</h1>")
                .append("</body></html>");
        //邮件内容
        helper.setText(stringBuffer.toString(), true);

        // 发送邮件
        javaMailSender.send(mimeMessage);
    }


最后:

    Spring从4.3后移除了对velocity模板邮件的支持.


猜你喜欢

转载自blog.csdn.net/q343509740/article/details/80888102