10 分鐘實現 Spring Boot 發生郵件功能

來源：yizhiwazi

jianshu.com/p/5eb000544dd7

  • 基礎知識
    • 什麼是SMTP？
    • 什麼是IMAP？
    • 什麼是POP3？
    • IMAP和POP3協議有什麼不同呢？
  • 進階知識
    • 什麼是JavaMailSender和JavaMailSenderImpl？
    • 如何通過JavaMailSenderImpl發送郵件？
    • 為什麼JavaMailSenderImpl 能夠開箱即用 ？
  • 使用教程
    • 一、開啟郵件服務
    • 二、配置郵件服務
    • 三、發送郵件和附件
    • 四、測試發送郵件
    • 五、常見失敗編碼

基礎知識

什麼是SMTP？

SMTP全稱為Simple Mail Transfer Protocol（簡單郵件傳輸協議），它是一組用於從源地址到目的地址傳輸郵件的規範，通過它來控制郵件的中轉方式。SMTP認證要求必須提供帳號和密碼才能登陸伺服器，其設計目的在於避免用戶受到垃圾郵件的侵擾。

什麼是IMAP？

IMAP全稱為Internet Message Access Protocol（互聯網郵件訪問協議），IMAP允許從郵件伺服器上獲取郵件的資訊、下載郵件等。IMAP與POP類似，都是一種郵件獲取協議。

什麼是POP3？

POP3全稱為Post Office Protocol 3（郵局協議），POP3支援客戶端遠程管理伺服器端的郵件。POP3常用於「離線」郵件處理，即允許客戶端下載伺服器郵件，然後伺服器上的郵件將會被刪除。目前很多POP3的郵件伺服器只提供下載郵件功能，伺服器本身並不刪除郵件，這種屬於改進版的POP3協議。

IMAP和POP3協議有什麼不同呢？

兩者最大的區別在於，IMAP允許雙向通訊，即在客戶端的操作會回饋到伺服器上，例如在客戶端收取郵件、標記已讀等操作，伺服器會跟著同步這些操作。而對於POP協議雖然也允許客戶端下載伺服器郵件，但是在客戶端的操作並不會同步到伺服器上面的，例如在客戶端收取或標記已讀郵件，伺服器不會同步這些操作。

進階知識

什麼是JavaMailSender和JavaMailSenderImpl？

JavaMailSender和JavaMailSenderImpl 是Spring官方提供的集成郵件服務的介面和實現類，以簡單高效的設計著稱，目前是Java後端發送郵件和集成郵件服務的主流工具。

如何通過JavaMailSenderImpl發送郵件？

非常簡單，直接在業務類注入JavaMailSenderImpl並調用send方法發送郵件。其中簡單郵件可以通過SimpleMailMessage來發送郵件，而複雜的郵件（例如添加附件）可以藉助MimeMessageHelper來構建MimeMessage發送郵件。例如：

@Autowired      private JavaMailSenderImpl mailSender;        public void sendMail() throws MessagingException {          //簡單郵件          SimpleMailMessage simpleMailMessage = new SimpleMailMessage();          simpleMailMessage.setFrom("[email protected]");          simpleMailMessage.setTo("[email protected]");          simpleMailMessage.setSubject("Happy New Year");          simpleMailMessage.setText("新年快樂！");          mailSender.send(simpleMailMessage);            //複雜郵件          MimeMessage mimeMessage = mailSender.createMimeMessage();          MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage);          messageHelper.setFrom("[email protected]");          messageHelper.setTo("[email protected]");          messageHelper.setSubject("Happy New Year");          messageHelper.setText("新年快樂！");          messageHelper.addInline("doge.gif", new File("xx/xx/doge.gif"));          messageHelper.addAttachment("work.docx", new File("xx/xx/work.docx"));          mailSender.send(mimeMessage);      }

為什麼JavaMailSenderImpl 能夠開箱即用 ？

所謂開箱即用其實就是基於官方內置的自動配置，翻看源碼可知曉郵件自動配置類(MailSenderPropertiesConfiguration) 為上下文提供了郵件服務實例(JavaMailSenderImpl)。具體源碼如下：

@Configuration  @ConditionalOnProperty(prefix = "spring.mail", name = "host")  class MailSenderPropertiesConfiguration {      private final MailProperties properties;      MailSenderPropertiesConfiguration(MailProperties properties) {          this.properties = properties;      }      @Bean      @ConditionalOnMissingBean      public JavaMailSenderImpl mailSender() {          JavaMailSenderImpl sender = new JavaMailSenderImpl();          applyProperties(sender);          return sender;      }

其中MailProperties是關於郵件伺服器的配置資訊，具體源碼如下：

@ConfigurationProperties(prefix = "spring.mail")  public class MailProperties {      private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;      private String host;      private Integer port;      private String username;      private String password;      private String protocol = "smtp";      private Charset defaultEncoding = DEFAULT_CHARSET;      private Map<String, String> properties = new HashMap<>();  }

使用教程

一、開啟郵件服務

登陸網易郵箱163，在設置中打開並勾選POP3/SMTP/IMAP服務，然後會得到一個授權碼，這個郵箱和授權碼將用作登陸認證。

二、配置郵件服務

首先咱們通過 Spring Initializr 創建工程springboot-send-mail，如圖所示：

然後在pom.xml 引入web、thymeleaf 和spring-boot-starter-mail等相關依賴。例如：

<dependencies>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-web</artifactId>          </dependency>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-thymeleaf</artifactId>          </dependency>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-mail</artifactId>          </dependency>          <dependency>              <groupId>org.webjars</groupId>              <artifactId>webjars-locator-core</artifactId>          </dependency>          <dependency>              <groupId>org.webjars</groupId>              <artifactId>jquery</artifactId>              <version>3.3.1</version>          </dependency>          <dependency>              <groupId>org.webjars</groupId>              <artifactId>bootstrap</artifactId>              <version>3.3.7</version>          </dependency>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-devtools</artifactId>              <scope>runtime</scope>          </dependency>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-test</artifactId>              <scope>test</scope>          </dependency>      </dependencies>

根據前面提到的配置項(MailProperties)填寫相關配置資訊，其中spring.mail.username 表示連接郵件伺服器時認證的登陸帳號，可以是普通的手機號或者登陸帳號，並非一定是郵箱，為了解決這個問題，推薦大家在spring.mail. properties.from填寫郵件發信人即真實郵箱。

然後在application.yml添加如下配置：

spring:    mail:      host: smtp.163.com #SMTP伺服器地址      username: socks #登陸帳號      password: 123456 #登陸密碼（或授權碼）      properties:        from: [email protected] #郵件發信人（即真實郵箱）    thymeleaf:      cache: false      prefix: classpath:/views/    servlet:      multipart:        max-file-size: 10MB #限制單個文件大小        max-request-size: 50MB #限制請求總量

透過前面的進階知識，我們知道在發送郵件前，需要先構建 SimpleMailMessage或 MimeMessage 郵件資訊類來填寫郵件標題、郵件內容等資訊，最後提交給JavaMailSenderImpl發送郵件，這樣看起來沒什麼問題，也能實現既定目標，但在實際使用中會出現大量零散和重複的程式碼，還不便於保存郵件到資料庫。

那麼優雅的發送郵件應該是如何的呢？應該屏蔽掉這些構建資訊和發送郵件的細節，不管是簡單還是複雜郵件，都可以通過統一的API來發送郵件。例如：mailService.send(mailVo) 。

例如通過郵件資訊類(MailVo) 來保存發送郵件時的郵件主題、郵件內容等資訊 ：

package com.hehe.vo;    public class MailVo {      private String id;//郵件id      private String from;//郵件發送人      private String to;//郵件接收人（多個郵箱則用逗號","隔開）      private String subject;//郵件主題      private String text;//郵件內容      private Date sentDate;//發送時間      private String cc;//抄送（多個郵箱則用逗號","隔開）      private String bcc;//密送（多個郵箱則用逗號","隔開）      private String status;//狀態      private String error;//報錯資訊      @JsonIgnore      private MultipartFile[] multipartFiles;//郵件附件     //省略GET&SET方法  }

三、發送郵件和附件

除了發送郵件之外，還包括檢測郵件和保存郵件等操作，例如：

  • 檢測郵件 checkMail(); 首先校驗郵件收信人、郵件主題和郵件內容這些必填項，若為空則拒絕發送。
  • 發送郵件 sendMimeMail(); 其次通過MimeMessageHelper來解析MailVo並構建MimeMessage傳輸郵件。
  • 保存郵件 sendMimeMail(); 最後將郵件保存到資料庫，便於統計和追查郵件問題。

本案例郵件業務類 MailService 的具體源碼如下：

package com.hehe.service;    /**   * 郵件業務類 MailService   */  @Service  public class MailService {        private Logger logger = LoggerFactory.getLogger(getClass());//提供日誌類        @Autowired      private JavaMailSenderImpl mailSender;//注入郵件工具類          /**       * 發送郵件       */      public MailVo sendMail(MailVo mailVo) {          try {              checkMail(mailVo); //1.檢測郵件              sendMimeMail(mailVo); //2.發送郵件              return saveMail(mailVo); //3.保存郵件          } catch (Exception e) {              logger.error("發送郵件失敗:", e);//列印錯誤資訊              mailVo.setStatus("fail");              mailVo.setError(e.getMessage());              return mailVo;          }        }        //檢測郵件資訊類      private void checkMail(MailVo mailVo) {          if (StringUtils.isEmpty(mailVo.getTo())) {              throw new RuntimeException("郵件收信人不能為空");          }          if (StringUtils.isEmpty(mailVo.getSubject())) {              throw new RuntimeException("郵件主題不能為空");          }          if (StringUtils.isEmpty(mailVo.getText())) {              throw new RuntimeException("郵件內容不能為空");          }      }        //構建複雜郵件資訊類      private void sendMimeMail(MailVo mailVo) {          try {              MimeMessageHelper messageHelper = new MimeMessageHelper(mailSender.createMimeMessage(), true);//true表示支援複雜類型              mailVo.setFrom(getMailSendFrom());//郵件發信人從配置項讀取              messageHelper.setFrom(mailVo.getFrom());//郵件發信人              messageHelper.setTo(mailVo.getTo().split(","));//郵件收信人              messageHelper.setSubject(mailVo.getSubject());//郵件主題              messageHelper.setText(mailVo.getText());//郵件內容              if (!StringUtils.isEmpty(mailVo.getCc())) {//抄送                  messageHelper.setCc(mailVo.getCc().split(","));              }              if (!StringUtils.isEmpty(mailVo.getBcc())) {//密送                  messageHelper.setCc(mailVo.getBcc().split(","));              }              if (mailVo.getMultipartFiles() != null) {//添加郵件附件                  for (MultipartFile multipartFile : mailVo.getMultipartFiles()) {                      messageHelper.addAttachment(multipartFile.getOriginalFilename(), multipartFile);                  }              }              if (StringUtils.isEmpty(mailVo.getSentDate())) {//發送時間                  mailVo.setSentDate(new Date());                  messageHelper.setSentDate(mailVo.getSentDate());              }              mailSender.send(messageHelper.getMimeMessage());//正式發送郵件              mailVo.setStatus("ok");              logger.info("發送郵件成功：{}->{}", mailVo.getFrom(), mailVo.getTo());          } catch (Exception e) {              throw new RuntimeException(e);//發送失敗          }      }        //保存郵件      private MailVo saveMail(MailVo mailVo) {          //將郵件保存到資料庫..          return mailVo;      }        //獲取郵件發信人      public String getMailSendFrom() {          return mailSender.getJavaMailProperties().getProperty("from");      }  }

搞定了發送郵件最核心的業務邏輯，接下來咱們寫一個簡單頁面用來發送郵件。

首先寫好跟頁面交互的控制器 MailController，具體源碼如下：

@RestController  public class MailController {      @Autowired      private MailService mailService;        /**       * 發送郵件的主介面       */      @GetMapping("/")      public ModelAndView index() {          ModelAndView mv = new ModelAndView("mail/sendMail");//打開發送郵件的頁面          mv.addObject("from", mailService.getMailSendFrom());//郵件發信人          return mv;      }      /**       * 發送郵件       */      @PostMapping("/mail/send")      public MailVo sendMail(MailVo mailVo, MultipartFile[] files) {          mailVo.setMultipartFiles(files);          return mailService.sendMail(mailVo);//發送郵件和附件      }  }

然後在/resources/views/mail目錄新建sendMail.html，具體源碼如下：

<!DOCTYPE html>  <html xmlns:th="http://www.thymeleaf.org">    <head>      <meta charset="UTF-8"/>      <title>發送郵件</title>      <link th:href="@{/webjars/bootstrap/css/bootstrap.min.css}" rel="stylesheet" type="text/css"/>      <script th:src="@{/webjars/jquery/jquery.min.js}"></script>      <script th:href="@{/webjars/bootstrap/js/bootstrap.min.js}"></script>    </head>    <body>  <div class="col-md-6" style="margin:20px;padding:20px;border: #E0E0E0 1px solid;">      <marquee behavior="alternate" onfinish="alert(12)" id="mq"               onMouseOut="this.start();$('#egg').text('嗯 真聽話！');"               onMouseOver="this.stop();$('#egg').text('有本事放開我呀！');">          <h5 id="egg">祝大家新年快樂！</h5><img id="doge" src="http://pics.sc.chinaz.com/Files/pic/faces/3709/7.gif" alt="">      </marquee>        <form class="form-horizontal" id="mailForm">          <div class="form-group">              <label class="col-md-2 control-label">郵件發信人:</label>              <div class="col-md-6">                  <input class="form-control" id="from" name="from" th:value="${from}" readonly="readonly">              </div>          </div>          <div class="form-group">              <label class="col-md-2 control-label">郵件收信人:</label>              <div class="col-md-6">                  <input class="form-control" id="to" name="to" title="多個郵箱使用,隔開">              </div>          </div>          <div class="form-group">              <label class="col-md-2 control-label">郵件主題:</label>              <div class="col-md-6">                  <input class="form-control" id="subject" name="subject">              </div>          </div>          <div class="form-group">              <label class="col-md-2 control-label">郵件內容:</label>              <div class="col-md-6">                  <textarea class="form-control" id="text" name="text" rows="5"></textarea>              </div>          </div>          <div class="form-group">              <label class="col-md-2 control-label">郵件附件:</label>              <div class="col-md-6">                  <input class="form-control" id="files" name="files" type="file" multiple="multiple">              </div>          </div>          <div class="form-group">              <label class="col-md-2 control-label">郵件操作:</label>              <div class="col-md-3">                  <a class="form-control btn btn-primary" onclick="sendMail()">發送郵件</a>              </div>              <div class="col-md-3">                  <a class="form-control btn btn-default" onclick="clearForm()">清空</a>              </div>          </div>      </form>        <script th:inline="javascript">          var appCtx = [[${#request.getContextPath()}]];            function sendMail() {                var formData = new FormData($('#mailForm')[0]);              $.ajax({                  url: appCtx + '/mail/send',                  type: "POST",                  data: formData,                  contentType: false,                  processData: false,                  success: function (result) {                      alert(result.status === 'ok' ? "發送成功！" : "你被Doge嘲諷了：" + result.error);                  },                  error: function () {                      alert("發送失敗！");                  }              });          }            function clearForm() {              $('#mailForm')[0].reset();          }            setInterval(function () {              var total = $('#mq').width();              var width = $('#doge').width();              var left = $('#doge').offset().left;              if (left <= width / 2 + 20) {                  $('#doge').css('transform', 'rotateY(180deg)')              }              if (left >= total - width / 2 - 40) {                  $('#doge').css('transform', 'rotateY(-360deg)')              }          });      </script>  </div>  </body>  </html>

四、測試發送郵件

如果是初學者，建議大家先下載源碼，修改配置後運行工程，成功後再自己重新寫一遍程式碼，這樣有助於加深記憶。

啟動工程並訪問：http://localhost:8080 然後可以看到發送郵件的主介面如下：

然後填寫你的小號郵箱，點擊發送郵件，若成功則可以登陸小號郵箱查看郵件和剛才上傳的附件。

至此發送郵件程式碼全部完成，歡迎大家下載並關注Github 源碼。

五、常見失敗編碼

如果企業訂製了郵件伺服器，自然會記錄郵件日誌，根據錯誤編碼存儲日誌有利於日常維護。

例如這些由網易郵箱提供的錯誤編碼標識：

421

  • 421 HL:REP 該IP發送行為異常，存在接收者大量不存在情況，被臨時禁止連接。請檢查是否有用戶發送病毒或者垃圾郵件，並核對發送列表有效性；
  • 421 HL:ICC 該IP同時並發連接數過大，超過了網易的限制，被臨時禁止連接。請檢查是否有用戶發送病毒或者垃圾郵件，並降低IP並發連接數量；
  • 421 HL:IFC 該IP短期內發送了大量信件，超過了網易的限制，被臨時禁止連接。請檢查是否有用戶發送病毒或者垃圾郵件，並降低發送頻率；
  • 421 HL:MEP 該IP發送行為異常，存在大量偽造發送域域名行為，被臨時禁止連接。請檢查是否有用戶發送病毒或者垃圾郵件，並使用真實有效的域名發送；

450

  • 450 MI:CEL 發送方出現過多的錯誤指令。請檢查發信程式；
  • 450 MI:DMC 當前連接發送的郵件數量超出限制。請減少每次連接中投遞的郵件數量；
  • 450 MI:CCL 發送方發送超出正常的指令數量。請檢查發信程式；
  • 450 RP:DRC 當前連接發送的收件人數量超出限制。請控制每次連接投遞的郵件數量；
  • 450 RP:CCL 發送方發送超出正常的指令數量。請檢查發信程式；
  • 450 DT:RBL 發信IP位於一個或多個RBL里。請參考http://www.rbls.org/關於RBL的相關資訊；
  • 450 WM:BLI 該IP不在網易允許的發送地址列表裡；
  • 450 WM:BLU 此用戶不在網易允許的發信用戶列表裡；

451

  • 451 DT:SPM ,please try again 郵件正文帶有垃圾郵件特徵或發送環境缺乏規範性，被臨時拒收。請保持郵件隊列，兩分鐘後重投郵件。需調整郵件內容或優化發送環境；
  • 451 Requested mail action not taken: too much fail authentication 登錄失敗次數過多，被臨時禁止登錄。請檢查密碼與帳號驗證設置；
  • 451 RP:CEL 發送方出現過多的錯誤指令。請檢查發信程式；
  • 451 MI:DMC 當前連接發送的郵件數量超出限制。請控制每次連接中投遞的郵件數量；
  • 451 MI:SFQ 發信人在15分鐘內的發信數量超過限制，請控制發信頻率；
  • 451 RP:QRC 發信方短期內累計的收件人數量超過限制，該發件人被臨時禁止發信。請降低該用戶發信頻率；
  • 451 Requested action aborted: local error in processing 系統暫時出現故障，請稍後再次嘗試發送；

500

  • 500 Error: bad syntaxU 發送的smtp命令語法有誤；
  • 550 MI:NHD HELO命令不允許為空；
  • 550 MI:IMF 發信人電子郵件地址不合規範。請參考http://www.rfc-editor.org/關於電子郵件規範的定義；
  • 550 MI:SPF 發信IP未被發送域的SPF許可。請參考http://www.openspf.org/關於SPF規範的定義；
  • 550 MI:DMA 該郵件未被發信域的DMARC許可。請參考http://dmarc.org/關於DMARC規範的定義；
  • 550 MI:STC 發件人當天的連接數量超出了限定數量，當天不再接受該發件人的郵件。請控制連接次數；
  • 550 RP:FRL 網易郵箱不開放匿名轉發（Open relay）；
  • 550 RP:RCL 群發收件人數量超過了限額，請減少每封郵件的收件人數量；
  • 550 RP:TRC 發件人當天內累計的收件人數量超過限制，當天不再接受該發件人的郵件。請降低該用戶發信頻率；
  • 550 DT:SPM 郵件正文帶有很多垃圾郵件特徵或發送環境缺乏規範性。需調整郵件內容或優化發送環境；
  • 550 Invalid User 請求的用戶不存在；
  • 550 User in blacklist 該用戶不被允許給網易用戶發信；
  • 550 User suspended 請求的用戶處于禁用或者凍結狀態；
  • 550 Requested mail action not taken: too much recipient 群發數量超過了限額；

552

  • 552 Illegal Attachment 不允許發送該類型的附件，包括以.uu .pif .scr .mim .hqx .bhx .cmd .vbs .bat .com .vbe .vb .js .wsh等結尾的附件；
  • 552 Requested mail action aborted: exceeded mailsize limit 發送的信件大小超過了網易郵箱允許接收的最大限制；

553

  • 553 Requested action not taken: NULL sender is not allowed 不允許發件人為空，請使用真實發件人發送；
  • 553 Requested action not taken: Local user only SMTP類型的機器只允許發信人是本站用戶；
  • 553 Requested action not taken: no smtp MX only MX類型的機器不允許發信人是本站用戶；
  • 553 authentication is required SMTP需要身份驗證，請檢查客戶端設置；

554

  • 554 DT:SPM 發送的郵件內容包含了未被許可的資訊，或被系統識別為垃圾郵件。請檢查是否有用戶發送病毒或者垃圾郵件；
  • 554 DT:SUM 信封發件人和信頭髮件人不匹配；
  • 554 IP is rejected, smtp auth error limit exceed 該IP驗證失敗次數過多，被臨時禁止連接。請檢查驗證資訊設置；
  • 554 HL:IHU 發信IP因發送垃圾郵件或存在異常的連接行為，被暫時掛起。請檢測發信IP在歷史上的發信情況和發信程式是否存在異常；
  • 554 HL:IPB 該IP不在網易允許的發送地址列表裡；
  • 554 MI:STC 發件人當天內累計郵件數量超過限制，當天不再接受該發件人的投信。請降低發信頻率；
  • 554 MI:SPB 此用戶不在網易允許的發信用戶列表裡；
  • 554 IP in blacklist 該IP不在網易允許的發送地址列表裡。

VirMach 便宜 VPS

QNews

QNews