紹

郵件服務(wù)是常用的服務(wù)之一，作用很多，對(duì)外可以給用戶發(fā)送活動(dòng)、營銷廣告等；對(duì)內(nèi)可以發(fā)送系統(tǒng)監(jiān)控報(bào)告與告警。

本文將介紹Springboot如何整合郵件服務(wù)，并給出不同郵件服務(wù)商的整合配置。

如圖所示：

開發(fā)過程

Springboot搭建

Springboot的搭建非常簡單，我們使用 https://start.spring.io/來構(gòu)建，十分方便，選擇需要用到的模塊，就能快速完成項(xiàng)目的搭建：

引入依賴

為了使用郵件服務(wù)，我們需要引入相關(guān)的依賴，對(duì)于Springboot加入下面的依賴即可：

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

配置文件

需要配置郵件服務(wù)提供商的相關(guān)參數(shù)，如服務(wù)地址、用戶名及密碼等。下面的例子是QQ的配置，其中密碼并不是QQ密碼，而是QQ授權(quán)碼，后續(xù)我們?cè)僦v怎么獲得。

Springboot的配置文件application.yml如下：

server:
 port: 8080
spring:
 profiles:
 active: qq
---
spring:
 profiles: qq
 mail:
 host: smtp.qq.com
 username: xxx@qq.com
 password: xxx
 properties:
 mail:
 smtp:
 auth: true
 starttls:
 enable: true
 required: true
---
spring:
 profiles: netEase
 mail:
 host: smtp.163.com
 username: xxx@163.com
 password: xxx
 properties:
 mail:
 smtp:
 auth: true
 starttls:
 enable: true
 required: true

實(shí)現(xiàn)發(fā)送服務(wù)

將JavaMailSender注入，組裝Message后，就可以發(fā)送最簡單的文本郵件了。

@Autowired
private JavaMailSender emailSender;
public void sendNormalText(String from, String to, String subject, String text) {
 SimpleMailMessage message = new SimpleMailMessage();
 message.setFrom(from);
 message.setTo(to);
 message.setSubject(subject);
 message.setText(text);
 emailSender.send(message);
}

調(diào)用接口

服務(wù)調(diào)用實(shí)現(xiàn)后，通過Controller對(duì)外暴露REST接口，具體代碼如下：

@Value("${spring.mail.username}")
private String username;
@Autowired
private MailService mailService;
@GetMapping("/normalText")
public Mono<String> sendNormalText() {
 mailService.sendNormalText(username, username,
 "Springboot Mail(Normal Text)",
 "This is a mail from Springboot!");
 return Mono.just("sent");
}

把實(shí)現(xiàn)的MailService注入到Controller里，調(diào)用對(duì)應(yīng)的方法即可。本次的郵件發(fā)送人和收件人都是同一個(gè)帳戶，實(shí)際實(shí)現(xiàn)可以靈活配置。

通過Postman調(diào)用接口來測(cè)試一下能不能正常發(fā)送：

成功返回"sent"，并收到了郵件，測(cè)試通過。

多種類型郵件

簡單文本郵件

簡單文本郵件如何發(fā)送，剛剛已經(jīng)講解，不再贅述。

HTML郵件

純文本雖然已經(jīng)能滿足很多需求，但很多時(shí)候也需要更加豐富的樣式來提高郵件的表現(xiàn)力。這時(shí)HTML類型的郵件就非常有用。

Service代碼如下：

public void sendHtml(String from, String to, String subject, String text) throws MessagingException {
 MimeMessage message = emailSender.createMimeMessage();
 MimeMessageHelper helper = new MimeMessageHelper(message, true);
 helper.setFrom(from);
 helper.setTo(to);
 helper.setSubject(subject);
 helper.setText(text, true);
 emailSender.send(message);
}

與簡單的文本不同的是，本次用到了MimeMessage和MimeMessageHelper，這是非常有用的類，后續(xù)我們經(jīng)常會(huì)用到，組合使用能大大豐富郵件表現(xiàn)形式。

Controller的代碼如下：

@GetMapping("/html")
public Mono<String> sendHtml() throws MessagingException {
 mailService.sendHtml(username, username,
 "Springboot Mail(HTML)",
 "<h1>This is a mail from Springboot!</h1>");
 return Mono.just("sent");
}

帶附件郵件

郵件發(fā)送文件再正常不過，發(fā)送附件需要使用MimeMessageHelper.addAttachment(String attachmentFilename, InputStreamSource inputStreamSource)方法，第一個(gè)參數(shù)為附件名，第二參數(shù)為文件流資源。Service代碼如下：

public void sendAttachment(String from, String to, String subject, String text, String filePath) throws MessagingException {
 MimeMessage message = emailSender.createMimeMessage();
 MimeMessageHelper helper = new MimeMessageHelper(message, true);
 helper.setFrom(from);
 helper.setTo(to);
 helper.setSubject(subject);
 helper.setText(text, true);
 FileSystemResource file = new FileSystemResource(new File(filePath));
 helper.addAttachment(filePath, file);
 emailSender.send(message);
}

Controller代碼如下：

@GetMapping("/attachment")
public Mono<String> sendAttachment() throws MessagingException {
 mailService.sendAttachment(username, username,
 "Springboot Mail(Attachment)",
 "<h1>Please check the attachment!</h1>",
 "/Pictures/postman.png");
 return Mono.just("sent");
}

帶靜態(tài)資源郵件

我們?cè)L問的網(wǎng)頁其實(shí)也是一個(gè)HTML，是可以帶很多靜態(tài)資源的，如圖片、視頻等。Service代碼如下：

public void sendStaticResource(String from, String to, String subject, String text, String filePath, String contentId) throws MessagingException {
 MimeMessage message = emailSender.createMimeMessage();
 MimeMessageHelper helper = new MimeMessageHelper(message, true);
 helper.setFrom(from);
 helper.setTo(to);
 helper.setSubject(subject);
 helper.setText(text, true);
 FileSystemResource file = new FileSystemResource(new File(filePath));
 helper.addInline(contentId, file);
 emailSender.send(message);
}

其中，contentId為HTML里靜態(tài)資源的ID，需要對(duì)應(yīng)好。

Controller代碼如下：

@GetMapping("/inlinePicture")
public Mono<String> sendStaticResource() throws MessagingException {
 mailService.sendStaticResource(username, username,
 "Springboot Mail(Static Resource)",
 "<html><body>With inline picture<img src='cid:picture' /></body></html>",
 "/Pictures/postman.png",
 "picture");
 return Mono.just("sent");
}

模板郵件

Java的模板引擎很多，著名的有Freemarker、Thymeleaf、Velocity等，這不是本點(diǎn)的重點(diǎn)，所以只以Freemarker為例使用。

Service代碼如下：

@Autowired
private FreeMarkerConfigurer freeMarkerConfigurer;
public void sendTemplateFreemarker(String from, String to, String subject, Map<String, Object> model, String templateFile) throws Exception {
 MimeMessage message = emailSender.createMimeMessage();
 MimeMessageHelper helper = new MimeMessageHelper(message, true);
 helper.setFrom(from);
 helper.setTo(to);
 helper.setSubject(subject);
 Template template = freeMarkerConfigurer.getConfiguration().getTemplate(templateFile);
 String html = FreeMarkerTemplateUtils.processTemplateIntoString(template, model);
 helper.setText(html, true);
 emailSender.send(message);
}

注意需要注入FreeMarkerConfigurer，然后使用FreeMarkerTemplateUtils解析模板，返回String，就可以作為內(nèi)容發(fā)送了。

Controller代碼如下：

@GetMapping("/template")
public Mono<String> sendTemplateFreemarker() throws Exception {
 Map<String, Object> model = new HashMap<>();
 model.put("username", username);
 model.put("templateType", "Freemarker");
 mailService.sendTemplateFreemarker(username, username,
 "Springboot Mail(Template)",
 model,
 "template.html");
 return Mono.just("sent");
}

注意模板文件template.html要放在resources/templates/目錄下面，這樣才能找得到。

模板內(nèi)容如下：

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>Title</title>
</head>
<body>
<h1>Hello ${username}</h1>
<h1>This is a mail from Springboot using ${templateType}</h1>
</body>
</html>

其中${username}和${templateType}為需要替換的變量名，Freemarker提供了很多豐富的變量表達(dá)式，這里不展開講了。

集成不同郵件服務(wù)商

郵件服務(wù)的提供商很多，國內(nèi)最常用的應(yīng)該是QQ郵箱和網(wǎng)易163郵箱了。

QQ

集成QQ郵件需要有必備的賬號(hào)，還要開通授權(quán)碼。開通授權(quán)碼后配置一下就可以使用了，官方的文檔如下：

https://service.mail.qq.com/cgi-bin/help?subtype=1&&no=1001256&&id=28

需要注意的是，開通授權(quán)碼是需要使用綁定的手機(jī)號(hào)發(fā)短信到特定號(hào)碼的，如果沒有綁定手機(jī)或者綁定手機(jī)不可用，那都會(huì)影響開通。

開通之后，授權(quán)碼就要以作為密碼配置到文件中。

163

網(wǎng)易的開通方式與QQ沒有太大差別，具體的指導(dǎo)可以看如下官方文檔：

http://help.mail.163.com/faqDetail.do?code=d7a5dc8471cd0c0e8b4b8f4f8e49998b374173cfe9171305fa1ce630d7f67ac2cda80145a1742516

同樣也是需要綁定手機(jī)進(jìn)行操作。

總結(jié)

本次例子發(fā)送后收到郵件如圖所示：

郵件功能強(qiáng)大，Springboot也非常容易整合。技術(shù)利器，善用而不濫用。