SpringBoot 发送邮件
引入jar包
<!-- SpringBoot邮件starter -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
<!-- freemarker模板 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
</dependency>
配置邮件发送方
在application.properties文件中添加以下配置,这里以qq邮箱为例
spring.mail.host=smtp.qq.com
# 发送方邮件
[email protected]
# qq邮箱的授权码,获取方式下边有介绍
spring.mail.password=abcdefg
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
授权码获取方式: 登录qq邮箱,到邮箱设置->安全->账号安全,如下图
测试发送简单邮件
@Autowired
private JavaMailSender javaMailSender;
@Test
public void test1() {
SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
// 邮件主题
simpleMailMessage.setSubject("测试");
// 邮件接收人邮箱
simpleMailMessage.setTo("[email protected]");
// 邮件内容
simpleMailMessage.setText("这是一封测试邮件");
javaMailSender.send(simpleMailMessage);
}
发送模板邮件
上面的测试发送了简单邮件,邮件内容是简单的文本字符串,这满足不了我们更复杂的需求。我们可以结合freemarker模板引擎,实现发送富文本功能的Mime邮件
@Autowired
private MailSendService mailSendService;
@Test
public void test2() {
Map<String, Object> params = new HashMap<>();
params.put("company", "a公司");
params.put("contact", "b联系方式");
params.put("email", "c询问下单邮件");
params.put("fax", "d传真");
params.put("more", "e备注");
Mail mail = new Mail();
// 设置接收方邮箱
mail.setReceiverEmail("[email protected]");
// 使用的模板名称
mail.setTemplateName("place_order.ftl");
// 设置
mail.setParams(params);
mail.setSubject("主题:测试邮件");
boolean isSucc = mailSendService.sendWithHTMLTemplate(mail);
}
测试结果如下,我收到了测试邮件
主要方法sendWithHTMLTemplate说明
/**
* spring提供的Java邮件发送类
*/
@Autowired
private JavaMailSender javaMailSender;
@Autowired
private FreeMarkerConfigurer freeMarkerConfigurer;
@Override
public boolean sendWithHTMLTemplate(Mail mail) {
try {
//发件人昵称
String nick = MimeUtility.encodeText("David");
//发件人网络地址
InternetAddress from = new InternetAddress(nick + "<[email protected]>");
MimeMessage mimeMessage = javaMailSender.createMimeMessage();
MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
mimeMessageHelper.setTo(mail.getReceiverEmail());
mimeMessageHelper.setFrom(from);
mimeMessageHelper.setSubject(mail.getSubject());
// 使用模板生成html邮件内容
String result = getMailTextByTemplateName(mail.getTemplateName(), mail.getParams());
mimeMessageHelper.setText(result, true);
javaMailSender.send(mimeMessage);
return true;
} catch (Exception e) {
log.error("TAG=sendEmailFailed, msg={}", e.getMessage());
return false;
}
}
@Override
public String getMailTextByTemplateName(String templateName, Map<String, Object> params) throws IOException, TemplateException {
String mailText = "";
// 通过指定模板名获取FreeMarker模板实例
Template template = freeMarkerConfigurer.getConfiguration().getTemplate(templateName);
// FreeMarker通过Map传递动态数据
// 注意动态数据的key和模板标签中指定的属性相匹配
// 解析模板并替换动态数据,最终code将替换模板文件中的${code}标签。
mailText = FreeMarkerTemplateUtils.processTemplateIntoString(template, params);
return mailText;
}
模板文件放在resources/templates文件夹即可
使用异步线程发送邮件
发送邮件时间比较长,这里简单配置下线程池,然后异步发送邮件
添加AsyncConfig配置类
@Configuration
@EnableAsync
public class AsyncConfig implements AsyncConfigurer {
@Override
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
// 线程池维护线程的最少数量
executor.setCorePoolSize(30);
// 线程池维护线程的最大数量
executor.setMaxPoolSize(50);
// 缓存队列 TODO 最大同时线程只能是maxPoolSize+Queue=150
executor.setQueueCapacity(100);
executor.setWaitForTasksToCompleteOnShutdown(true);
executor.setAwaitTerminationSeconds(60 * 10);
// 拒绝task的处理策略, 当pool已经达到max size的时候, 抛出异常
executor.setThreadNamePrefix("AsyncThread-");
// 如果不初始化, 导致找到不到执行器
executor.initialize();
return executor;
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return new AsyncExceptionHandler();
}
}
配置好之后,只需要在需要异步执行的方法上面添加@Async注解即可实现该方法的异步执行,例如我们在sendWithHTMLTemplate()方法上添加@Async注解,则实现了sendWithHTMLTemplate()方法的异步执行
@Async
@Override
public boolean sendWithHTMLTemplate(Mail mail) {
...
}
具体代码请参考GitHub项目
这里偷个懒,把代码放在之前的resttemplate项目下
GitHub