Spring Boot使用JavaMailSender发送邮件
Spring Boot使用JavaMailSender发送邮件
Spring提供了非常好用的JavaMailSender接口实现邮件发送。在Spring Boot的Starter模块中也为此提供了自动化配置。
第一章 快速入门
Spring Boot的工程中的pom.xml中引入spring-boot-starter-mail依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency> |
配置application.properties邮箱的相关属性(注意替换自己的用户名和密码):
- 163邮箱为例
spring.mail.host=smtp.163.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 |
- QQ邮箱为例
spring.mail.host=smtp.qq.com spring.mail.username=用户名 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 |
通过单元测试来实现一封简单邮件的发送:
@RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration(classes = Application.class) public class ApplicationTests { @Autowired private JavaMailSender mailSender; @Test public void sendSimpleMail() throws Exception { SimpleMailMessage message = new SimpleMailMessage(); message.setFrom("*****@qq.com"); message.setTo("*****@qq.com"); message.setSubject("标题:简单邮件"); message.setText("测试1邮件内容!"); mailSender.send(message); } } |
第二章 进阶使用
SimpleMailMessage实现了简单的邮件发送;MimeMessage实现附件、邮件模块等复杂一些的邮件内容发送。
2.1. 发送附件
通过MimeMessageHelper来发送一封带有附件的邮件:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
@Test public void sendAttachmentsMail() throws Exception {
MimeMessage mimeMessage = mailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true); helper.setFrom("*****@qq.com"); helper.setTo("*****@qq.com"); helper.setSubject("主题:有附件"); helper.setText("有附件的邮件");
FileSystemResource file = new FileSystemResource(new File("weixin.jpg")); helper.addAttachment("附件-1.jpg", file); helper.addAttachment("附件-2.jpg", file); mailSender.send(mimeMessage);
} |
2.2. 嵌入静态资源
除了发送附件之外,我们在邮件内容中可能希望通过嵌入图片等静态资源,让邮件获得更好的阅读体验,而不是从附件中查看具体图片,下面的测试用例演示了如何通过MimeMessageHelper实现在邮件正文中嵌入静态资源。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
@Test public void sendInlineMail() throws Exception {
MimeMessage mimeMessage = mailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true); helper.setFrom("*****@qq.com"); helper.setTo("*****@qq.com"); helper.setSubject("主题:嵌入静态资源"); helper.setText("<html><body><img src=\"cid:weixin\" ></body></html>", true);
FileSystemResource file = new FileSystemResource(new File("weixin.jpg")); helper.addInline("weixin", file);
mailSender.send(mimeMessage);
} |
注意:addInline函数中资源名称weixin需要与正文中cid:weixin对应起来。
2.3. 模板邮件
通常我们使用邮件发送服务的时候,都会有一些固定的场景,比如重置密码、注册确认等,给每个用户发送的内容可能只有小部分是变化的。所以,很多时候我们会使用模板引擎来为各类邮件设置成模板,这样我们只需要在发送时去替换变化部分的参数即可。
在Spring Boot中使用模板引擎来实现模板化的邮件发送也是非常容易的,下面我们以velocity为例实现一下。
引入velocity模块的依赖:
1 2 3 4 |
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-velocity</artifactId> </dependency> |
在resources/templates/下,创建一个模板页面template.vm:
1 2 3 4 5 |
<html> <body> <h3>你好, ${username}, 这是一封模板邮件!</h3> </body> </html> |
我们之前在Spring Boot中开发Web应用时,提到过在Spring Boot的自动化配置下,模板默认位于resources/templates/目录下
最后,我们在单元测试中加入发送模板邮件的测试用例,具体如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
@Test public void sendTemplateMail() throws Exception {
MimeMessage mimeMessage = mailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true); helper.setFrom("*******@qq.com"); helper.setTo("*****@qq.com"); helper.setSubject("主题:模板邮件");
Map<String, Object> model = new HashedMap(); model.put("username", "didi"); String text = VelocityEngineUtils.mergeTemplateIntoString( velocityEngine, "template.vm", "UTF-8", model); helper.setText(text, true);
mailSender.send(mimeMessage); } |
尝试运行一下,就可以收到内容为你好, didi, 这是一封模板邮件!的邮件。这里,我们通过传入username的参数,在邮件内容中替换了模板中的${username}变量。
https://gitee.com/didispace/SpringBoot-Learning 完整示例:Chapter4-5-1
第三章 常见问题
三.1. 邮箱开启授权码
javax.mail.AuthenticationFailedException: 550 User has no permission出错。
三.1.1. 邮箱163设置
163邮箱开启pop3/smtp等协议,然后用授权码代替密码来登陆就可以发送邮件成功。163配置开启pop3/smtp等协议。
1.1. 登录邮箱--设置--选择POP3/SMTP/IMAP
1.2. 开启POP3/SMTP服务
1.3. 按照提示扫码,使用邮箱注册手机号码发短信
3.1.2. 邮箱QQ设置
3.2. 授权码出错导致535错误
javax.mail.AuthenticationFailedException: 535 Error: authentication failed问题解决。开启授权码后依然报这个错,结果是我把授权码写错了;然后项目启动,还是报这个错,再检查发现我把邮箱写错了,所以配置的时候邮箱一定要写正确!
3.3. 邮件在垃圾箱的问题
此问题可能是由于发送的内容是纯文本格式引起的;可以改成html的格式试下,我的就是改了就可以了;
3.4. 遇到554的情况如果是因为文件格式校验不通过不发送邮件的,可以把邮件抄送给发件人一份
3.5. 发送邮件给不同的邮箱(如163\qq\126\139等),当有html标签时,各个邮箱解析不一样,就会在邮件中显示html标签,所以使用通用的html标签来回车换行和空格,测试兼容(163/qq/139);
第四章 参考材料
https://www.cnblogs.com/ysocean/p/7666061.html
https://www.cnblogs.com/yucongblog/p/7385434.html