SpringBoot Mail郵件任務詳情

2022-05-22 19:00:14

一、引言

傳送郵件應該是網站的必備功能之一，什麼註冊驗證，忘記密碼或者是給使用者傳送行銷資訊。最早期的時候我們會使用JavaMail相關api來寫傳送郵件的相關程式碼，後來spring退出了JavaMailSender更加簡化了郵件傳送的過程，在之後springboot對此進行了封裝就有了現在的spring-boot-starter-mail,本章文章的介紹主要來自於此包。

二、簡單使用

1、pom包設定

pom包裡面新增spring-boot-starter-mail包參照

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

2、在application.properties中新增郵箱設定

spring.mail.host=smtp.1234.163.com //郵箱伺服器地址
spring.mail.username=5678@oo.com //使用者名稱
spring.mail.password=09876 //密碼
spring.mail.default-encoding=UTF-8
mail.fromMail.addr=65432@oo.com //以誰來傳送郵件

3、編寫mailService,這裡只提出實現類。

@Component
public class MailServiceImpl implements MailService{
private final Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
private JavaMailSender mailSender;
@Value("${mail.fromMail.addr}")
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);
}
}
}

4、編寫test類進行測試

@RunWith(SpringRunner.class)
@SpringBootTest
public class MailServiceTest {
@Autowired
private MailService MailService;
@Test
public void testSimpleMail() throws Exception {
MailService.sendSimpleMail("123456w@126.com","test simple mail"," hello this is simple mail");
}
}

至此一個簡單的文字傳送就完成了。

三、加點料

但是在正常使用的過程中，我們通常在郵件中加入圖片或者附件來豐富郵件的內容，下面講介紹如何使用springboot來傳送豐富的郵件。

3、傳送html格式郵件

其它都不變在MailService新增sendHtmlMail方法.

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);
}
}

在測試類中構建html內容，測試傳送：

@Test
public void testHtmlMail() throws Exception {
String content="<html>n" +
"<body>n" +
" <h3>hello world ! 這是一封Html郵件!</h3>n" +
"</body>n" +
"</html>";
MailService.sendHtmlMail("ityouknow@126.com","test simple mail",content);
}

3、傳送帶附件的郵件

在MailService新增sendAttachmentsMail方法.

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);

FileSystemResource file = new FileSystemResource(new File(filePath));
String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
helper.addAttachment(fileName, file);

mailSender.send(message);
logger.info("帶附件的郵件已經傳送。");
} catch (MessagingException e) {
logger.error("傳送帶附件的郵件時發生異常！", e);
}
}

新增多個附件可以使用多條 helper.addAttachment(fileName, file)

4、在測試類中新增測試方法

@Test
public void sendAttachmentsMail() {
String filePath="e:\tmp\application.log";
mailService.sendAttachmentsMail("ityouknow@126.com", "主題：帶附件的郵件", "有附件，請查收！", filePath);
}

5、傳送帶靜態資源的郵件

郵件中的靜態資源一般就是指圖片，在MailService新增sendAttachmentsMail方法.

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);
}
}

在測試類中新增測試方法：

@Test
public void sendInlineResourceMail() {
String rscId = "12345";
String content="<html><body>這是有圖片的郵件：<img src='cid:" + rscId + "' ></body></html>";
String imgPath = "C:\Users\summer\Pictures\favicon.png";
mailService.sendInlineResourceMail("ityouknow@126.com", "主題：這是有圖片的郵件", content, imgPath, rscId);
}

新增多個圖片可以使用多條 <img src='cid:" + rscId + "' > 和 helper.addInline(rscId, res) 來實現
到此所有的郵件傳送服務已經完成了。

郵件系統：

上面傳送郵件的基礎服務就這些了，但是如果我們要做成一個郵件系統的話還需要考慮以下幾個問題：

郵件模板：

我們會經常收到這樣的郵件：
尊敬的neo使用者：
恭喜您註冊成為xxx網的使用者,，同時感謝您對xxx的關注與支援並歡迎您使用xx的產品與服務。
...
其中只有neo這個使用者名稱在變化，其它郵件內容均不變，如果每次傳送郵件都需要手動拼接的話會不夠優雅，並且每次模板的修改都需要改動程式碼的話也很不方便，因此對於這類郵件需求，都建議做成郵件模板來處理。模板的本質很簡單，就是在模板中替換變化的引數，轉換為html字串即可，這裡以thymeleaf為例來演示。

四、pom中匯入thymeleaf的包

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

五、在resorces/templates下建立emailTemplate.html

<!DOCTYPE html>
<html lang="zh" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"/>
<title>Title</title>
</head>
<body>
您好,這是驗證郵件,請點選下面的連結完成驗證,

<a href="#" rel="external nofollow"  th:href="@{ http://www.i123456w.com/neo/{id}(id=${id}) }" rel="external nofollow" >啟用賬號</a>
</body>
</html>

六、解析模板並行送

@Test
public void sendTemplateMail() {
//建立郵件正文
Context context = new Context();
context.setVariable("id", "006");
String emailContent = templateEngine.process("emailTemplate", context);

mailService.sendHtmlMail("ityouknow@126.com","主題：這是模板郵件",emailContent);
}