在Spring Boot的工程中的pom.xml中引入spring-boot-starter-mail依賴:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency>
如其他自動化配置模塊一樣,在完成了依賴引入之后,只需要在application.properties
中配置相應的屬性內容。
下面我們以QQ郵箱為例,在application.properties
中加入如下配置(注意替換自己的用戶名和密碼):
spring.mail.host=smtp.qq.com spring.mail.username=用戶名 spring.mail.password=密碼 spring.mail.properties.mail.smtp.auth=true spring.mail.properties.mail.smtp.starttls.enable=true spring.mail.properties.mail.smtp.starttls.required=true
application.yml
mail: host: mail.dahuatech.com default-encoding: UTF-8 port: 25 username: dh_zdxmzh@dahuatech.com password: PMO@2020.4.1 properties: mail: smtp: auth: true starttls: enable: false required: false
通過單元測試來實現一封簡單郵件的發送:
@RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration(classes = Application.class) public class ApplicationTests { @Autowired private JavaMailSender mailSender; @Test public void sendSimpleMail() throws Exception { SimpleMailMessage message = new SimpleMailMessage(); message.setFrom("dyc87112@qq.com"); message.setTo("dyc87112@qq.com"); message.setSubject("主題:簡單郵件"); message.setText("測試郵件內容"); mailSender.send(message); } }
“由於Spring Boot的starter模塊提供了自動化配置,所以在引入了spring-boot-starter-mail依賴之后,會根據配置文件中的內容去創建JavaMailSender實例,因此我們可以直接在需要使用的地方直接@Autowired來引入郵件發送對象。”
進階使用
在上例中,我們通過使用SimpleMailMessage實現了簡單的郵件發送,但是實際使用過程中,我們還可能會帶上附件、或是使用郵件模塊等。這個時候我們就需要使用MimeMessage來設置復雜一些的郵件內容,下面我們就來依次實現一下。
發送附件
在上面單元測試中加入如下測試用例(通過MimeMessageHelper來發送一封帶有附件的郵件):
@Test public void sendAttachmentsMail() throws Exception { MimeMessage mimeMessage = mailSender.createMimeMessage(); MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true); helper.setFrom("dyc87112@qq.com"); helper.setTo("dyc87112@qq.com"); helper.setSubject("主題:有附件"); helper.setText("有附件的郵件"); FileSystemResource file = new FileSystemResource(new File("weixin.jpg")); helper.addAttachment("附件-1.jpg", file); helper.addAttachment("附件-2.jpg", file); mailSender.send(mimeMessage); }
嵌入靜態資源
除了發送附件之外,我們在郵件內容中可能希望通過嵌入圖片等靜態資源,讓郵件獲得更好的閱讀體驗,而不是從附件中查看具體圖片,下面的測試用例演示了如何通過MimeMessageHelper實現在郵件正文中嵌入靜態資源。
@Test public void sendInlineMail() throws Exception { MimeMessage mimeMessage = mailSender.createMimeMessage(); MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true); helper.setFrom("dyc87112@qq.com"); helper.setTo("dyc87112@qq.com"); helper.setSubject("主題:嵌入靜態資源"); helper.setText("<html><body><img src=\"cid:weixin\" ></body></html>", true); FileSystemResource file = new FileSystemResource(new File("weixin.jpg")); helper.addInline("weixin", file); mailSender.send(mimeMessage); }
這里需要注意的是addInline函數中資源名稱weixin需要與正文中cid:weixin對應起來
模板郵件
通常我們使用郵件發送服務的時候,都會有一些固定的場景,比如重置密碼、注冊確認等,給每個用戶發送的內容可能只有小部分是變化的。所以,很多時候我們會使用模板引擎來為各類郵件設置成模板,這樣我們只需要在發送時去替換變化部分的參數即可。
在Spring Boot中使用模板引擎來實現模板化的郵件發送也是非常容易的,下面我們以FreeMarker為例實現一下。
引用 freeMarker jar引用. jar版本根據自己的情況選擇
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-freemarker --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId> <version>2.3.1.RELEASE</version> </dependency>
在resources/templates/下,創建一個模板頁面template.ftl: <FTL>
<html> <body> <h3>你好, ${username}, 這是一封模板郵件!</h3> </body> </html>
使用模板
@Autowired private JavaMailSender mailSender; @Autowired private FreeMarkerConfigurer freeMarkerConfigurer;
//使用JavaMail的MimeMessage,支付更加復雜的郵件格式和內容 MimeMessage msg = mailSender.createMimeMessage(); //創建MimeMessageHelper對象,處理MimeMessage的輔助類 MimeMessageHelper helper = new MimeMessageHelper(msg, true); //使用輔助類MimeMessage設定參數 helper.setFrom(from); helper.setTo(recipients); helper.setCc(copyRecipients); helper.setSubject(subject); Map<String,Object> dataMap = JsonUtil.parseObject(mailContext,new TypeReference<Map<String,Object>>(){}); Template template = freeMarkerConfigurer.getConfiguration().getTemplate(templateName+".ftl"); try{ String text = FreeMarkerTemplateUtils.processTemplateIntoString(template,dataMap); helper.setText(text,true); }catch (TemplateException e){ e.printStackTrace(); } //加載文件資源,作為附件 // ClassPathResource file = new ClassPathResource("Chrysanthemum.jpg"); //加入附件 // helper.addAttachment("attachment.jpg", file); // 發送郵件 mailSender.send(msg);