用过Spring 开发者对JavaMailSender应该不陌生,它是Spring 提供邮件发送的接口。在Spring Boot中对这块应用也进行了自动化的封装。下面我们就来实际操作一下如何在Spring Boot项目中使用JavaMailSender进行邮件的发送操作。
首先我们需要创建一个Maven项目并且引入Spring Boot的基本依赖,然后再引入邮件发送相关的场景启动器,代码如下。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.5</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
第二步,在引入了自动配置场景启动类之后,剩余的配置与之前的其他配置一样,需要在application.yml 或者是application.properties中进行配置。下面我们演示利用QQ邮箱邮件发送效果。
spring:
#邮箱基本配置
mail:
#配置smtp服务主机地址
host: smtp.qq.com
#发送者邮箱
username: xxxxxxx@qq.com
#配置密码,注意不是真正的密码,而是刚刚申请到的授权码
password: xxxxxxxxxxx
#端口号465或587
port: 587
#默认的邮件编码为UTF-8
default-encoding: UTF-8
#其他参数
properties:
mail:
#配置SSL 加密工厂
smtp:
ssl:
#本地测试,先放开ssl
enable: false
required: false
#开启debug模式,这样邮件发送过程的日志会在控制台打印出来,方便排查错误
debug: true
指定邮箱类型如下图所示
这里我们创建一个一般邮件格式都有的实体类,包括收件人、邮件主题、邮件内容、以及附件路径等内容。
@Data
public class MailRequest implements Serializable {
/**
* 接收人
*/
private String sendTo;
/**
* 邮件主题
*/
private String subject;
/**
* 邮件内容
*/
private String text;
/**
* 附件路径
*/
private String filePath;
}
完成邮件实体配置之后,我们需要定义一个邮件服务。
public interface SendMailService {
/**
* 简单文本邮件
*
* @param mailRequest
* @return
*/
void sendSimpleMail(MailRequest mailRequest);
/**
* Html格式邮件,可带附件
*
* @param mailRequest
* @return
*/
void sendHtmlMail(MailRequest mailRequest);
}
邮件服务实现
@Service
public class SendMailServiceImpl implements SendMailService {
//注入邮件工具类
@Autowired
private JavaMailSender javaMailSender;
@Value("${spring.mail.username}")
private String sendMailer;
private static final Logger logger = LoggerFactory.getLogger(SendMailServiceImpl.class);
public void checkMail(MailRequest mailRequest) {
Assert.notNull(mailRequest,"邮件请求不能为空");
Assert.notNull(mailRequest.getSendTo(), "邮件收件人不能为空");
Assert.notNull(mailRequest.getSubject(), "邮件主题不能为空");
Assert.notNull(mailRequest.getText(), "邮件收件人不能为空");
}
@Override
public void sendSimpleMail(MailRequest mailRequest) {
SimpleMailMessage message = new SimpleMailMessage();
checkMail(mailRequest);
//邮件发件人
message.setFrom(sendMailer);
//邮件收件人 1或多个
message.setTo(mailRequest.getSendTo().split(","));
//邮件主题
message.setSubject(mailRequest.getSubject());
//邮件内容
message.setText(mailRequest.getText());
//邮件发送时间
message.setSentDate(new Date());
javaMailSender.send(message);
logger.info("发送邮件成功:{}->{}",sendMailer,mailRequest.getSendTo());
}
@Override
public void sendHtmlMail(MailRequest mailRequest) {
MimeMessage message = javaMailSender.createMimeMessage();
checkMail(mailRequest);
try {
MimeMessageHelper helper = new MimeMessageHelper(message,true);
//邮件发件人
helper.setFrom(sendMailer);
//邮件收件人 1或多个
helper.setTo(mailRequest.getSendTo().split(","));
//邮件主题
helper.setSubject(mailRequest.getSubject());
//邮件内容
helper.setText(mailRequest.getText(),true);
//邮件发送时间
helper.setSentDate(new Date());
String filePath = mailRequest.getFilePath();
if (StringUtils.hasText(filePath)) {
FileSystemResource file = new FileSystemResource(new File(filePath));
String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
helper.addAttachment(fileName,file);
}
javaMailSender.send(message);
logger.info("发送邮件成功:{}->{}",sendMailer,mailRequest.getSendTo());
} catch (MessagingException e) {
logger.error("发送邮件时发生异常!",e);
}
}
}
@RestController
@RequestMapping("/sendmail")
public class SendMailController {
@Autowired
private SendMailService sendMailService;
@PostMapping("/simple")
public void SendSimpleMessage(@RequestBody MailRequest mailRequest) {
sendMailService.sendSimpleMail(mailRequest);
}
@PostMapping("/html")
public void SendHtmlMessage(@RequestBody MailRequest mailRequest) {
sendMailService.sendHtmlMail(mailRequest);
}
}
完成配置之后,调用Controller接口就可以实现对指定的邮箱发送消息了。
何在Spring boot中配置和发送邮件呢,今天我们就以QQ邮件为例,给大家说一下在spring Boot中发送,包括简单邮件,html格式邮件,包含附件的邮件,和发送图片内容的邮件
spring boot配置邮件
package com.team.base.service;
import lombok.extern.java.Log;
import lombok.extern.log4j.Log4j;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Service;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.io.File;
/**
* @com.team.base.service
* @fenghaiju
* @2018/3/19-16:46
* @springBootBase
**/
@Service
@Slf4j
public class MailService {
@Autowired
private JavaMailSender sender;
@Value("${spring.mail.username}")
private String from;
/**
* 发送纯文本的简单邮件
* @param to
* @param subject
* @param content
*/
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 {
sender.send(message);
log.info("简单邮件已经发送。");
} catch (Exception e) {
log.error("发送简单邮件时发生异常!",e);
}
}
/**
* 发送html格式的邮件
* @param to
* @param subject
* @param content
*/
public void sendHtmlMail(String to, String subject, String content){
MimeMessage message = sender.createMimeMessage();
try {
//true表示需要创建一个multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(from);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, true);
sender.send(message);
log.info("html邮件已经发送。");
} catch (MessagingException e) {
log.error("发送html邮件时发生异常!",e);
}
}
/**
* 发送带附件的邮件
* @param to
* @param subject
* @param content
* @param filePath
*/
public void sendAttachmentsMail(String to, String subject, String content, String filePath){
MimeMessage message = sender.createMimeMessage();
try {
//true表示需要创建一个multipart message
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);
sender.send(message);
log.info("带附件的邮件已经发送。");
} catch (MessagingException e) {
log.error("发送带附件的邮件时发生异常!",e);
}
}
/**
* 发送嵌入静态资源(一般是图片)的邮件
* @param to
* @param subject
* @param content 邮件内容,需要包括一个静态资源的id,比如:<img src=\"cid:rscId01\" >
* @param rscPath 静态资源路径和文件名
* @param rscId 静态资源id
*/
public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId){
MimeMessage message = sender.createMimeMessage();
try {
//true表示需要创建一个multipart message
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);
sender.send(message);
log.info("嵌入静态资源的邮件已经发送。");
} catch (MessagingException e) {
log.error("发送嵌入静态资源的邮件时发生异常!",e);
}
}
}
package com.team.base.controller; import com.team.base.service.MailService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; /** * @com.team.base.controller * @fenghaiju * @2018/3/19-16:51 * @springBootBase **/ @RestController @RequestMapping("/mail") public class MailController { @Autowired private MailService mailService; /** * 简单发送 * @return */ @RequestMapping("/sendSimpleMail") public ResponseEntity<?> sendSimpleMail(){ mailService.sendSimpleMail("fenghaiju@sohu.com", "简单邮件", "简单的邮件测试"); return ResponseEntity.ok(true); } /** * 发送html内容 * @return */ @RequestMapping("/sendHtmlMail") public ResponseEntity<?> sendHtmlMail(){ mailService.sendHtmlMail("fenghaiju@sohu.com", "html邮件", "<html><body><h3>你好, 这是一封模板邮件!</h3></body></html>"); return ResponseEntity.ok(true); } /** * 发送附件 * @return */ @RequestMapping("/sendAttachmentsMail") public ResponseEntity<?> sendAttachmentsMail(){ mailService.sendAttachmentsMail("fenghaiju@sohu.com", "附件邮件", "测试邮件内容","D:\\article\\结尾.txt"); return ResponseEntity.ok(true); } /** * 发送图片 * @return */ @RequestMapping("/sendInlineResourceMail") public ResponseEntity<?> sendInlineResourceMail(){ mailService.sendInlineResourceMail("fenghaiju@sohu.com", "发送图片", "<img src=\"cid:rscId01\" >","D:\\article\\架构师.png","rscId01"); return ResponseEntity.ok(true); } }
企业邮箱中创建个性化的电子邮件模板,可以在创作邮件时节省时间,快速的完成邮件;并且根据设置好的格式,也不会丢下关键的信息内容,那么这些具体是怎样实现的呢?下面介绍具体实现的内容。
*请认真填写需求信息,我们会在24小时内与您取得联系。