前言:
工作生活中,经常会用邮件告知收件人,例如我们经常碰到的注册验证邮件。早期大家都用JavaMail相关的API来写发送邮件,后来spring推出JavaMailSender简化了邮件发送过程(有兴趣的朋友可以自行研究一下JavaMailSender这个接口),再之后springBoot对此封装有了现在的spring-boot-starter-mail。
JavaMail是Sun定义的一套收发电子邮件的API,是JavaEE一部分。JavaMailSender底层也是基于JavaMailjar包的。
通信协议:
SMTP:简单邮件传输协议,用于发送电子邮件的传输协议;
POP3:用于接收电子邮件的标准协议;
IMAP:互联网消息协议,是POP3的替代协议。
这三种协议都有对应SSL加密传输的协议,分别是SMTPS,POP3S和IMAPS。除JavaMail服务提供程序之外,JavaMail还需要JAF(JavaBeans Activation Framework)来处理不是纯文本的邮件内容,这包括MIME(多用途互联网邮件扩展)、URL页面和文件附件等内容。
正文:
JavaMail中的关键对象。
Properties
:属性对象。针对不同的的邮件协议,JavaMail
规定了服务提供者必须支持一系列属性。
Session:会话对象。和web中的session不一样的,简单来说,它就是配置的集合。
Session的主要作用包括两个方面:
接收各种配置属性信息:通过Properties对象设置的属性信息;
初始化JavaMail环境:根据JavaMail的配置文件,初始化JavaMail环境,以便通过Session对象创建其他重要类的实例。
Transport
和Store
:传输和存储邮件操作只有发送或接收两种处理方式,JavaMail将这两种不同操作描述为传输(javax.mail.Transport
)和存储(javax.mail.Store
),传输对应邮件的发送,而存储对应邮件的接收。
Message:消息对象一旦获得Session
对象,就可以继续创建要发送的消息。Message是个抽象类,常用的实现类为:javax.mail.internet.MimeMessage。
Address:创建了Session
和Message
,并将内容填入消息后,就可以用Address
确定信件地址了。Address
也是个抽象类。对应常用实现类:javax.mail.internet.InternetAddress
。
Spring
封装后,使用起来基本上都不需要去关心这些对象值了,简单了解下即可。
SpringBoot集成
pom包配置
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies>
MailServiceImpl
import org.slf4j.Logger; import org.slf4j.LoggerFactory; 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.Component; import javax.mail.MessagingException; import javax.mail.internet.MimeMessage; import java.io.File; @Component public class MailServiceImpl implements MailService{ private final Logger logger = LoggerFactory.getLogger(this.getClass()); @Autowired private JavaMailSender mailSender; @Value("${mail.sender:[email protected]}") private String from; @Override 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 { mailSender.send(message); logger.info("简单邮件已经发送。"); } catch (Exception e) { logger.error("发送简单邮件时发生异常!", e); } } @Override public void sendHtmlMail(String to, String subject, String content) { MimeMessage message = mailSender.createMimeMessage(); try { //true表示需要创建一个multipart message MimeMessageHelper helper = new MimeMessageHelper(message, true); helper.setFrom(from); helper.setTo(to); helper.setSubject(subject); helper.setText(content, true); mailSender.send(message); logger.info("html邮件发送成功"); } catch (MessagingException e) { logger.error("发送html邮件时发生异常!", e.getMessage()); } } @Override public void sendAttachmentsMail(String to, String subject, String content, String filePath) { MimeMessage message = mailSender.createMimeMessage(); try { MimeMessageHelper helper = new MimeMessageHelper(message, true); helper.setFrom(from); helper.setTo(to); helper.setSubject(subject); helper.setText(content, true); File file = new File(filePath); //获取文件名 String fileName = file.getAbsolutePath().substring(file.getAbsolutePath().lastIndexOf("/")+1); helper.addAttachment(fileName, file); mailSender.send(message); logger.info("带附件的邮件已经发送。"); } catch (MessagingException e) { logger.error("发送带附件的邮件时发生异常!", e); } } @Override public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId) { MimeMessage message = mailSender.createMimeMessage(); try { 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); mailSender.send(message); logger.info("嵌入静态资源的邮件已经发送。"); } catch (MessagingException e) { logger.error("发送嵌入静态资源的邮件时发生异常!", e); } } }
application.properties
(QQ邮箱邮箱授权码获取放式:设置->用户->POP3/SMTP服务:开启)
#设置邮件发送人
mail.sender = XXX
# JavaMailSender 邮件发送的配置
spring.mail.host=smtp.qq.com
spring.mail.username=xxx
spring.mail.properties.mail.smtp.socketFactory.port = 465
spring.mail.properties.mail.smtp.socketFactory.class = javax.net.ssl.SSLSocketFactory
spring.mail.properties.mail.smtp.socketFactory.fallback = false
#QQ邮箱的授权码
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.default-encoding=UTF-8
#freemarker配置
spring.freemarker.content-type=text/html
spring.freemarker.suffix=.ftl
spring.freemarker.template-loader-path=classpath:/templates
spring.freemarker.charset=UTF-8
spring.freemarker.check-template-location=true
测试代码:
发送简单邮件
mport com.example.java.mail.MailService; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; @RunWith(SpringJUnit4ClassRunner.class) @SpringBootTest(classes= JavaApplication.class) //启动类名 @EnableAutoConfiguration public class Test { @Autowired private MailService mailService; @org.junit.Test public void testSimpleMail() throws Exception { mailService.sendSimpleMail("[email protected]","测试邮件"," hello this is simple mail"); } }
发送HTML格式邮件
@Test public void testHtmlMail() throws Exception { String content="<html>\n" + "<body>\n" + " <h3>hello world ! 这是一封html邮件!</h3>\n" + "</body>\n" + "</html>"; mailService.sendHtmlMail("[email protected]","test simple mail",content); }
发送带附件的邮件
@Test public void sendAttachmentsMail() { String filePath="./test-output/index.html"; mailService.sendAttachmentsMail("[email protected]", "主题:带附件测试报告的邮件", "有附件测试报告,请查收!", filePath); }
发送静态资源
@Test public void sendInlineResourceMail() { String rscId = "test"; String content="<html><body>这是有图片的邮件:<img src=\'cid:" + rscId + "\' ></body></html>"; String imgPath = "/Users/apple/Downloads/图片/ads-beverage-black-coffee-33972.jpg"; mailService.sendInlineResourceMail("[email protected]", "主题:这是有图片的邮件", content, imgPath, rscId); }