在很多服務中我經常需要用到發送郵件功能,所幸的是SpringBoot可以快速使用的框架spring-boot-starter-mail
,只要引入改框架我們可以快速的完成發送郵件功能。
引入mail
Jar
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
獲取郵件發送服務器配置
在國內用的最多的就是QQ郵件和網易163郵件,這裏會簡單講解獲取兩家服務商的發送郵件配置。
QQ郵箱
等錄QQ郵箱,點擊設置
然後選擇賬戶
在下方可以看到POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服務
,然後我們需要把smtp
服務開啓,開啓成功後會得到一個祕鑰。如圖所示:
開啓成功需要在application.properties
配置文件中加入相應的配置,以下信息部分需要替換爲自己的信息,教程結束下面的賬號就會被停用
spring.mail.host=smtp.qq.com
[email protected] # 替換爲自己的QQ郵箱號
spring.mail.password=owqpkjmqiasnbigc # 替換爲自己的祕鑰或授權碼
spring.mail.port=465
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
# sender
[email protected] # 替換爲自己的QQ郵箱號
163郵箱
登錄賬戶然後在設置
找到POP3/SMTP/IMAP
選項,然後開啓smtp服務,具體操作如下圖所示,然後修改對應的配置文件
spring.mail.host=smtp.163.com
[email protected] # 替換爲自己的163郵箱號
spring.mail.password=owqpkj163MC # 替換爲自己的授權碼
spring.mail.port=465
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
# sender
[email protected] # 替換爲自己的163郵箱號
實現簡單發送郵件
這裏發送郵件我們主要用到的是JavaMailSender
對象,發送簡單郵件主要是發送字符串內容,複雜的郵件我們可能會添加附件或者是發送HTML格式的郵件,我們先測試簡單的發送,代碼如下:
override fun sendSimple(receiver: String, title: String, content: String) {
logger.info("發送簡單郵件服務")
val message = mailSender.createMimeMessage()
val helper = MimeMessageHelper(message, true)
helper.setFrom(sender)
helper.setTo(receiver)
helper.setSubject(title)
helper.setText(content)
mailSender.send(message)
}
測試代碼
@RunWith(SpringJUnit4ClassRunner::class)
@SpringBootTest
class MailServiceImplTest {
@Autowired lateinit var mailService: MailService
@Test
fun sendSimple() {
mailService.sendSimple("[email protected]", "Hello Kotlin Mail", "SpringBoot Kotlin 專欄學習之JavaMailSender發送郵件")
}
}
檢查郵件是否收到發送的內容
發送模板郵件
我們這裏用的HTML模板引擎是thymeleaf
,大家需要引入一下spring-boot-starter-thymeleaf
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
有個地方需要注意,SpringBoot項目默認靜態資源都是放在resources/templates
目錄下,所以我們編寫的HTML模板就需要放在該目錄下,具體內容如下:
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title th:text="${title}">Title</title>
</head>
<body>
<h1 th:text="${name}">Demo</h1>
<h1 th:text="${phone}">xxx</h1>
</body>
</html>
發送模板郵件主要實現代碼
override fun sendMail(receiver: String, title: String, o: Any, templateName: String) {
logger.info("開始發送郵件服務,To:{}", receiver)
val message = mailSender.createMimeMessage()
val helper = MimeMessageHelper(message, true)
helper.setFrom(sender)
helper.setTo(receiver)
helper.setSubject(title)
val context = Context()
context.setVariable("title", title)
/*
* 設置動態數據,這裏不建議強轉,具體業務需求傳入具體的對象
*/
context.setVariables(o as MutableMap<String, Any>?)
/*
* 讀取取模板html代碼並賦值
*/
val content = templateEngine.process(templateName, context)
helper.setText(content, true)
mailSender.send(message)
logger.info("郵件發送結束")
}
測試代碼
@Test
fun sendMail() {
val model = HashMap<String, Any>()
model["name"] = "Tom"
model["phone"] = "69288888"
mailService.sendMail("[email protected]", "Kotlin Template Mail", model, "mail")
}
查看郵件我們可以看到如下內容:
郵件添加附件
附件的添加也是非常容易的,我需要先把發送的附件放在resources/templates
目錄下,然後在MimeMessageHelper
對象中設置相應的屬性即可,如下所示:
helper.addAttachment("test.txt", FileSystemResource(File("test.txt")))
完整的代碼
package io.intodream.kotlin06.service.impl
import io.intodream.kotlin06.service.MailService
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.javamail.JavaMailSender
import org.springframework.mail.javamail.MimeMessageHelper
import org.springframework.stereotype.Service
import org.thymeleaf.TemplateEngine
import org.thymeleaf.context.Context
import java.io.File
/**
* {描述}
*
* @author [email protected]
* @date 2019/4/8 19:19
*
*/
@Service
class MailServiceImpl @Autowired constructor(private var mailSender: JavaMailSender, private var templateEngine: TemplateEngine) : MailService{
val logger : Logger = LoggerFactory.getLogger(MailServiceImpl::class.java)
@Value("\${email.sender}")
val sender: String = "[email protected]"
override fun sendSimple(receiver: String, title: String, content: String) {
logger.info("發送簡單郵件服務")
val message = mailSender.createMimeMessage()
val helper = MimeMessageHelper(message, true)
helper.setFrom(sender)
helper.setTo(receiver)
helper.setSubject(title)
helper.setText(content)
mailSender.send(message)
}
override fun sendMail(receiver: String, title: String, o: Any, templateName: String) {
logger.info("開始發送郵件服務,To:{}", receiver)
val message = mailSender.createMimeMessage()
val helper = MimeMessageHelper(message, true)
helper.setFrom(sender)
helper.setTo(receiver)
helper.setSubject(title)
val context = Context()
context.setVariable("title", title)
/*
* 設置動態數據,這裏不建議強轉,具體業務需求傳入具體的對象
*/
context.setVariables(o as MutableMap<String, Any>?)
/*
* 添加附件
*/
helper.addAttachment("test.txt", FileSystemResource(File("test.txt")))
/*
* 讀取取模板html代碼並賦值
*/
val content = templateEngine.process(templateName, context)
helper.setText(content, true)
mailSender.send(message)
logger.info("郵件發送結束")
}
}
測試代碼
package io.intodream.kotlin06.service.impl
import io.intodream.kotlin06.service.MailService
import org.junit.Test
import org.junit.runner.RunWith
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner
/**
* {描述}
*
* @author [email protected]
* @date 2019/4/9 18:38
*/
@RunWith(SpringJUnit4ClassRunner::class)
@SpringBootTest
class MailServiceImplTest {
@Autowired lateinit var mailService: MailService
@Test
fun sendSimple() {
mailService.sendSimple("[email protected]", "Hello Kotlin Mail",
"SpringBoot Kotlin 專欄學習之JavaMailSender發送郵件")
}
@Test
fun sendMail() {
val model = HashMap<String, Any>()
model["name"] = "Tom"
model["phone"] = "69288888"
mailService.sendMail("[email protected]", "Kotlin Template Mail", model, "mail")
}
}
關於Kotlin使用JavaMailSender
發送郵件的介紹就到此結束了,如果大家覺得教程有用麻煩點一下贊,如果有錯誤的地方歡迎指出。