SpringBoot实现发送邮件功能
时间：2022-10-06 11:58:10 | 栏目：JAVA代码 | 点击：次
背景
有个小伙伴问我你以前发邮件功能怎么弄的。然后我就给他找了个demo，正好在此也写一下，分享给大家。
理清痛点
发送邮件，大家可以想一下，坑的地方在哪？
我觉得是三个吧。
第一：邮件白名单问题。
第二：邮件超时问题。
第三：邮件带附件问题。
我下面的demo都会介绍这些问题及解决。
实现方案
准备工作
我们先要准备一个可以发送的邮箱，我这里以我的163邮箱为例，现在发送邮件的规则，要求你输入一种叫做授权码的东西，注意这个东西不是密码。
获取授权码的步骤：
当选择开启，通过验证之后就可以获取到验证码。选择重置验证码也可以获取。以前17年的时候就写过一个demo，现在19年又开了一个，因为以前的忘了。
SpringBoot项目引入邮件包
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency>
yml配置邮件相关
spring: mail: # 邮件服务地址 host: smtp.163.com # 端口,可不写默认 port: 25 # 编码格式 default-encoding: utf-8 # 用户名 username: xxx@163.com # 授权码，就是我们刚才准备工作获取的代码 password: xxx # 其它参数 properties: mail: smtp: # 如果是用 SSL 方式，需要配置如下属性,使用qq邮箱的话需要开启 ssl: enable: true required: true # 邮件接收时间的限制，单位毫秒 timeout: 10000 # 连接时间的限制，单位毫秒 connectiontimeout: 10000 # 邮件发送时间的限制，单位毫秒 writetimeout: 10000
针对于上面提的超时问题，捕获超时异常就可解决。
邮件发送工具类
主要通过以下工具类就可以满足发送java邮件的需要。当我们进行好 yml 配置后，SpringBoot会帮助我们自动配置 JavaMailSender 我们通过这个java类就可以实现操作java来发送邮件。以下列举了几种常用的邮件。
@Service
public class MailService {
private static final Logger logger = LoggerFactory.getLogger(MailServiceImpl.class);
@Autowired
private JavaMailSender mailSender;
private static final String SENDER = "xxx@163.com";
/**
* 发送普通邮件
*
* @param to 收件人
* @param subject 主题
* @param content 内容
*/
@Override
public void sendSimpleMailMessge(String to, String subject, String content) {
SimpleMailMessage message = new SimpleMailMessage();
message.setFrom(SENDER);
message.setTo(to);
message.setSubject(subject);
message.setText(content);
try {
mailSender.send(message);
} catch (Exception e) {
logger.error("发送简单邮件时发生异常!", e);
}
}
/**
* 发送 HTML 邮件
*
* @param to 收件人
* @param subject 主题
* @param content 内容
*/
@Override
public void sendMimeMessge(String to, String subject, String content) {
MimeMessage message = mailSender.createMimeMessage();
try {
//true表示需要创建一个multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(SENDER);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, true);
mailSender.send(message);
} catch (MessagingException e) {
logger.error("发送MimeMessge时发生异常！", e);
}
}
/**
* 发送带附件的邮件
*
* @param to 收件人
* @param subject 主题
* @param content 内容
* @param filePath 附件路径
*/
@Override
public void sendMimeMessge(String to, String subject, String content, String filePath) {
MimeMessage message = mailSender.createMimeMessage();
try {
//true表示需要创建一个multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(SENDER);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, true);
FileSystemResource file = new FileSystemResource(new File(filePath));
String fileName = file.getFilename();
helper.addAttachment(fileName, file);
mailSender.send(message);
} catch (MessagingException e) {
logger.error("发送带附件的MimeMessge时发生异常！", e);
}
}
/**
* 发送带静态文件的邮件
*
* @param to 收件人
* @param subject 主题
* @param content 内容
* @param rscIdMap 需要替换的静态文件
*/
@Override
public void sendMimeMessge(String to, String subject, String content, Map<String, String> rscIdMap) {
MimeMessage message = mailSender.createMimeMessage();
try {
//true表示需要创建一个multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setFrom(SENDER);
helper.setTo(to);
helper.setSubject(subject);
helper.setText(content, true);
for (Map.Entry<String, String> entry : rscIdMap.entrySet()) {
FileSystemResource file = new FileSystemResource(new File(entry.getValue()));
helper.addInline(entry.getKey(), file);
}
mailSender.send(message);
} catch (MessagingException e) {
logger.error("发送带静态文件的MimeMessge时发生异常！", e);
}
}
}
发送邮件的demo
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbooEmailDemoApplicationTests {
@Autowired
private MailService mailService;
private static final String TO = "xxx@qq.com";
private static final String SUBJECT = "测试邮件";
private static final String CONTENT = "test content";
/**
* 测试发送普通邮件
*/
@Test
public void sendSimpleMailMessage() {
mailService.sendSimpleMailMessge(TO, SUBJECT, CONTENT);
}
/**
* 测试发送html邮件
*/
@Test
public void sendHtmlMessage() {
String htmlStr = "<h1>Test</h1>";
mailService.sendMimeMessge(TO, SUBJECT, htmlStr);
}
/**
* 测试发送带附件的邮件
* @throws FileNotFoundException
*/
@Test
public void sendAttachmentMessage() throws FileNotFoundException {
File file = ResourceUtils.getFile("classpath:test.txt");
String filePath = file.getAbsolutePath();
mailService.sendMimeMessge(TO, SUBJECT, CONTENT, filePath);
}
/**
* 测试发送带附件的邮件
* @throws FileNotFoundException
*/
@Test
public void sendPicMessage() throws FileNotFoundException {
String htmlStr = "<html><body>测试：图片1 <br> <img src=\'cid:pic1\'/> <br>图片2 <br> <img src=\'cid:pic2\'/></body></html>";
Map<String, String> rscIdMap = new HashMap<>(2);
rscIdMap.put("pic1", ResourceUtils.getFile("classpath:pic01.jpg").getAbsolutePath());
rscIdMap.put("pic2", ResourceUtils.getFile("classpath:pic02.jpg").getAbsolutePath());
mailService.sendMimeMessge(TO, SUBJECT, htmlStr, rscIdMap);
}
}
白名单问题
如果是发送给固定邮箱，可以直接在固定邮箱里面设置白名单，如果频繁的发送给多个邮箱，最好设置以下发送时间间隔，不要不断的给某一个邮箱发送。
总结