10 分鐘實(shí)現(xiàn) Java 發(fā)送郵件功能

pring Boot集成郵件服務(wù)竟如此簡單，快速掌握郵件業(yè)務(wù)類的核心邏輯和企業(yè)郵件的日常服務(wù)。

什么是SMTP？

SMTP全稱為Simple Mail Transfer Protocol（簡單郵件傳輸協(xié)議），它是一組用于從源地址到目的地址傳輸郵件的規(guī)范，通過它來控制郵件的中轉(zhuǎn)方式。SMTP認(rèn)證要求必須提供賬號(hào)和密碼才能登陸服務(wù)器，其設(shè)計(jì)目的在于避免用戶受到垃圾郵件的侵?jǐn)_。

什么是IMAP？

IMAP全稱為Internet Message Access Protocol（互聯(lián)網(wǎng)郵件訪問協(xié)議），IMAP允許從郵件服務(wù)器上獲取郵件的信息、下載郵件等。IMAP與POP類似，都是一種郵件獲取協(xié)議。

什么是POP3？

POP3全稱為Post Office Protocol 3（郵局協(xié)議），POP3支持客戶端遠(yuǎn)程管理服務(wù)器端的郵件。POP3常用于“離線”郵件處理，即允許客戶端下載服務(wù)器郵件，然后服務(wù)器上的郵件將會(huì)被刪除。目前很多POP3的郵件服務(wù)器只提供下載郵件功能，服務(wù)器本身并不刪除郵件，這種屬于改進(jìn)版的POP3協(xié)議。

IMAP和POP3協(xié)議有什么不同呢？

兩者最大的區(qū)別在于，IMAP允許雙向通信，即在客戶端的操作會(huì)反饋到服務(wù)器上，例如在客戶端收取郵件、標(biāo)記已讀等操作，服務(wù)器會(huì)跟著同步這些操作。而對(duì)于POP協(xié)議雖然也允許客戶端下載服務(wù)器郵件，但是在客戶端的操作并不會(huì)同步到服務(wù)器上面的，例如在客戶端收取或標(biāo)記已讀郵件，服務(wù)器不會(huì)同步這些操作。

什么是JavaMailSender和JavaMailSenderImpl？

JavaMailSender和JavaMailSenderImpl 是Spring官方提供的集成郵件服務(wù)的接口和實(shí)現(xiàn)類，以簡單高效的設(shè)計(jì)著稱，目前是Java后端發(fā)送郵件和集成郵件服務(wù)的主流工具。

如何通過JavaMailSenderImpl發(fā)送郵件？

非常簡單，直接在業(yè)務(wù)類注入JavaMailSenderImpl并調(diào)用send方法發(fā)送郵件。其中簡單郵件可以通過SimpleMailMessage來發(fā)送郵件，而復(fù)雜的郵件（例如添加附件）可以借助MimeMessageHelper來構(gòu)建MimeMessage發(fā)送郵件。例如：

@Autowired
    private JavaMailSenderImpl mailSender;

    public void sendMail() throws MessagingException {
        
        SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
        simpleMailMessage.setFrom("admin@163.com");
        simpleMailMessage.setTo("socks@qq.com");
        simpleMailMessage.setSubject("Happy New Year");
        simpleMailMessage.setText("新年快樂！");
        mailSender.send(simpleMailMessage);

        
        MimeMessage mimeMessage = mailSender.createMimeMessage();
        MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage);
        messageHelper.setFrom("admin@163.com");
        messageHelper.setTo("socks@qq.com");
        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 能夠開箱即用 ？

所謂開箱即用其實(shí)就是基于官方內(nèi)置的自動(dòng)配置，翻看源碼可知曉郵件自動(dòng)配置類(MailSenderPropertiesConfiguration) 為上下文提供了郵件服務(wù)實(shí)例(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是關(guān)于郵件服務(wù)器的配置信息，具體源碼如下：

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

一、開啟郵件服務(wù)

登陸網(wǎng)易郵箱163，在設(shè)置中打開并勾選POP3/SMTP/IMAP服務(wù)，然后會(huì)得到一個(gè)授權(quán)碼，這個(gè)郵箱和授權(quán)碼將用作登陸認(rèn)證。

二、配置郵件服務(wù)首先咱們通過 Spring Initializr 創(chuàng)建工程

springboot-send-mail，如圖所示：

然后在pom.xml 引入web、thymeleaf 和spring-boot-starter-mail等相關(guān)依賴。例如：

<dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
        dependency>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-thymeleafartifactId>
        dependency>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-mailartifactId>
        dependency>
        <dependency>
            <groupId>org.webjarsgroupId>
            <artifactId>webjars-locator-coreartifactId>
        dependency>
        <dependency>
            <groupId>org.webjarsgroupId>
            <artifactId>jqueryartifactId>
            <version>3.3.1version>
        dependency>
        <dependency>
            <groupId>org.webjarsgroupId>
            <artifactId>bootstrapartifactId>
            <version>3.3.7version>
        dependency>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-devtoolsartifactId>
            <scope>runtimescope>
        dependency>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-testartifactId>
            <scope>testscope>
        dependency>
    dependencies>

根據(jù)前面提到的配置項(xiàng)(MailProperties)填寫相關(guān)配置信息，其中spring.mail.username 表示連接郵件服務(wù)器時(shí)認(rèn)證的登陸賬號(hào)，可以是普通的手機(jī)號(hào)或者登陸賬號(hào)，并非一定是郵箱，為了解決這個(gè)問題，推薦大家在spring.mail. properties.from填寫郵件發(fā)信人即真實(shí)郵箱。

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

spring:
  mail:
    host: smtp.163.com #SMTP服務(wù)器地址
    username: socks #登陸賬號(hào)
    password: 123456 #登陸密碼（或授權(quán)碼）
    properties:
      from: socks@163.com #郵件發(fā)信人（即真實(shí)郵箱）
  thymeleaf:
    cache: false
    prefix: classpath:/views/
  servlet:
    multipart:
      max-file-size: 10MB #限制單個(gè)文件大小
      max-request-size: 50MB #限制請求總量

透過前面的進(jìn)階知識(shí)，我們知道在發(fā)送郵件前，需要先構(gòu)建SimpleMailMessage或 MimeMessage 郵件信息類來填寫郵件標(biāo)題、郵件內(nèi)容等信息，最后提交給JavaMailSenderImpl發(fā)送郵件，這樣看起來沒什么問題，也能實(shí)現(xiàn)既定目標(biāo)，但在實(shí)際使用中會(huì)出現(xiàn)大量零散和重復(fù)的代碼，還不便于保存郵件到數(shù)據(jù)庫。

那么優(yōu)雅的發(fā)送郵件應(yīng)該是如何的呢？應(yīng)該屏蔽掉這些構(gòu)建信息和發(fā)送郵件的細(xì)節(jié)，不管是簡單還是復(fù)雜郵件，都可以通過統(tǒng)一的API來發(fā)送郵件。例如：mailService.send(mailVo) 。例如通過郵件信息類(MailVo) 來保存發(fā)送郵件時(shí)的郵件主題、郵件內(nèi)容等信息：

package com.hehe.vo;

public class MailVo {
    private String 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;
   
}

三、發(fā)送郵件和附件

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

檢測郵件 checkMail(); 首先校驗(yàn)郵件收信人、郵件主題和郵件內(nèi)容這些必填項(xiàng)，若為空則拒絕發(fā)送。
發(fā)送郵件 sendMimeMail(); 其次通過MimeMessageHelper來解析MailVo并構(gòu)建MimeMessage傳輸郵件。
保存郵件 sendMimeMail(); 最后將郵件保存到數(shù)據(jù)庫，便于統(tǒng)計(jì)和追查郵件問題。

本案例郵件業(yè)務(wù)類 MailService 的具體源碼如下：

package com.hehe.service;


@Service
public class MailService {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @Autowired
    private JavaMailSenderImpl mailSender;


    
    public MailVo sendMail(MailVo mailVo) {
        try {
            checkMail(mailVo);
            sendMimeMail(mailVo);
            return saveMail(mailVo);
        } catch (Exception e) {
            logger.error("發(fā)送郵件失敗:", 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("郵件內(nèi)容不能為空");
        }
    }

    
    private void sendMimeMail(MailVo mailVo) {
        try {
            MimeMessageHelper messageHelper = new MimeMessageHelper(mailSender.createMimeMessage(), 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("發(fā)送郵件成功：{}->{}", 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");
    }
}

搞定了發(fā)送郵件最核心的業(yè)務(wù)邏輯，接下來咱們寫一個(gè)簡單頁面用來發(fā)送郵件。

首先寫好跟頁面交互的控制器 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，具體源碼如下：


<html xmlns:th="http://www.thymeleaf.org">

<head>
    <meta charset="UTF-8"/>
    <title>發(fā)送郵件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">郵件發(fā)信人: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="多個(gè)郵箱使用,隔開">
            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">郵件內(nèi)容: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()">發(fā)送郵件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' ? "發(fā)送成功！" : "你被Doge嘲諷了：" + result.error);
                },
                error: function () {
                    alert("發(fā)送失敗！");
                }
            });
        }

        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>

四、測試發(fā)送郵件

如果是初學(xué)者，建議大家先下載源碼，修改配置后運(yùn)行工程，成功后再自己重新寫一遍代碼，這樣有助于加深記憶。

啟動(dòng)工程并訪問：http://localhost:8080 然后可以看到發(fā)送郵件的主界面如下：

然后填寫你的小號(hào)郵箱，點(diǎn)擊發(fā)送郵件，若成功則可以登陸小號(hào)郵箱查看郵件和剛才上傳的附件。

至此發(fā)送郵件代碼全部完成，歡迎大家下載并關(guān)注Github 源碼。

五、常見失敗編碼

如果企業(yè)定制了郵件服務(wù)器，自然會(huì)記錄郵件日志，根據(jù)錯(cuò)誤編碼存儲(chǔ)日志有利于日常維護(hù)。例如這些由網(wǎng)易郵箱提供的錯(cuò)誤編碼標(biāo)識(shí)：421421 HL:REP 該IP發(fā)送行為異常，存在接收者大量不存在情況，被臨時(shí)禁止連接。請檢查是否有用戶發(fā)送病毒或者垃圾郵件，并核對(duì)發(fā)送列表有效性；

421 HL:ICC 該IP同時(shí)并發(fā)連接數(shù)過大，超過了網(wǎng)易的限制，被臨時(shí)禁止連接。請檢查是否有用戶發(fā)送病毒或者垃圾郵件，并降低IP并發(fā)連接數(shù)量；

421 HL:IFC 該IP短期內(nèi)發(fā)送了大量信件，超過了網(wǎng)易的限制，被臨時(shí)禁止連接。請檢查是否有用戶發(fā)送病毒或者垃圾郵件，并降低發(fā)送頻率；

421 HL:MEP 該IP發(fā)送行為異常，存在大量偽造發(fā)送域域名行為，被臨時(shí)禁止連接。請檢查是否有用戶發(fā)送病毒或者垃圾郵件，并使用真實(shí)有效的域名發(fā)送；

450450 MI:CEL 發(fā)送方出現(xiàn)過多的錯(cuò)誤指令。請檢查發(fā)信程序；

450 MI:DMC 當(dāng)前連接發(fā)送的郵件數(shù)量超出限制。請減少每次連接中投遞的郵件數(shù)量；

450 MI:CCL 發(fā)送方發(fā)送超出正常的指令數(shù)量。請檢查發(fā)信程序；

450 RP:DRC 當(dāng)前連接發(fā)送的收件人數(shù)量超出限制。請控制每次連接投遞的郵件數(shù)量；

450 RP:CCL 發(fā)送方發(fā)送超出正常的指令數(shù)量。請檢查發(fā)信程序；

450 DT:RBL 發(fā)信IP位于一個(gè)或多個(gè)RBL里。請參考

http://www.rbls.org/關(guān)于RBL的相關(guān)信息；

450 WM:BLI 該IP不在網(wǎng)易允許的發(fā)送地址列表里；

450 WM:BLU 此用戶不在網(wǎng)易允許的發(fā)信用戶列表里；451451 DT:SPM ,please try again 郵件正文帶有垃圾郵件特征或發(fā)送環(huán)境缺乏規(guī)范性，被臨時(shí)拒收。請保持郵件隊(duì)列，兩分鐘后重投郵件。需調(diào)整郵件內(nèi)容或優(yōu)化發(fā)送環(huán)境；

451 Requested mail action not taken: too much fail authentication 登錄失敗次數(shù)過多，被臨時(shí)禁止登錄。請檢查密碼與帳號(hào)驗(yàn)證設(shè)置；

451 RP:CEL 發(fā)送方出現(xiàn)過多的錯(cuò)誤指令。請檢查發(fā)信程序；

451 MI:DMC 當(dāng)前連接發(fā)送的郵件數(shù)量超出限制。請控制每次連接中投遞的郵件數(shù)量；

451 MI:SFQ 發(fā)信人在15分鐘內(nèi)的發(fā)信數(shù)量超過限制，請控制發(fā)信頻率；

451 RP:QRC 發(fā)信方短期內(nèi)累計(jì)的收件人數(shù)量超過限制，該發(fā)件人被臨時(shí)禁止發(fā)信。請降低該用戶發(fā)信頻率；

451 Requested action aborted: local error in processing 系統(tǒng)暫時(shí)出現(xiàn)故障，請稍后再次嘗試發(fā)送；500500 Error: bad syntaxU 發(fā)送的smtp命令語法有誤；

550 MI:NHD HELO命令不允許為空；

550 MI:IMF 發(fā)信人電子郵件地址不合規(guī)范。請參考http://www.rfc-editor.org/關(guān)于電子郵件規(guī)范的定義；

550 MI:SPF 發(fā)信IP未被發(fā)送域的SPF許可。請參考http://www.openspf.org/關(guān)于SPF規(guī)范的定義；

550 MI:DMA 該郵件未被發(fā)信域的DMARC許可。請參考http://dmarc.org/關(guān)于DMARC規(guī)范的定義；

550 MI:STC 發(fā)件人當(dāng)天的連接數(shù)量超出了限定數(shù)量，當(dāng)天不再接受該發(fā)件人的郵件。請控制連接次數(shù)；

550 RP:FRL 網(wǎng)易郵箱不開放匿名轉(zhuǎn)發(fā)（Open relay）；

550 RP:RCL 群發(fā)收件人數(shù)量超過了限額，請減少每封郵件的收件人數(shù)量；

550 RP:TRC 發(fā)件人當(dāng)天內(nèi)累計(jì)的收件人數(shù)量超過限制，當(dāng)天不再接受該發(fā)件人的郵件。請降低該用戶發(fā)信頻率；

550 DT:SPM 郵件正文帶有很多垃圾郵件特征或發(fā)送環(huán)境缺乏規(guī)范性。需調(diào)整郵件內(nèi)容或優(yōu)化發(fā)送環(huán)境；

550 Invalid User 請求的用戶不存在；

550 User in blacklist 該用戶不被允許給網(wǎng)易用戶發(fā)信；

550 User suspended 請求的用戶處于禁用或者凍結(jié)狀態(tài)；

550 Requested mail action not taken: too much recipient 群發(fā)數(shù)量超過了限額；552552 Illegal Attachment 不允許發(fā)送該類型的附件，包括以.uu .pif .scr .mim .hqx .bhx .cmd .vbs .bat .com .vbe .vb .js .wsh等結(jié)尾的附件；

552 Requested mail action aborted: exceeded mailsize limit 發(fā)送的信件大小超過了網(wǎng)易郵箱允許接收的最大限制；553553 Requested action not taken: NULL sender is not allowed 不允許發(fā)件人為空，請使用真實(shí)發(fā)件人發(fā)送；

553 Requested action not taken: Local user only SMTP類型的機(jī)器只允許發(fā)信人是本站用戶；

553 Requested action not taken: no smtp MX only MX類型的機(jī)器不允許發(fā)信人是本站用戶；

553 authentication is required SMTP需要身份驗(yàn)證，請檢查客戶端設(shè)置；554554 DT:SPM 發(fā)送的郵件內(nèi)容包含了未被許可的信息，或被系統(tǒng)識(shí)別為垃圾郵件。請檢查是否有用戶發(fā)送病毒或者垃圾郵件；

554 DT:SUM 信封發(fā)件人和信頭發(fā)件人不匹配；

554 IP is rejected, smtp auth error limit exceed 該IP驗(yàn)證失敗次數(shù)過多，被臨時(shí)禁止連接。請檢查驗(yàn)證信息設(shè)置；

554 HL:IHU 發(fā)信IP因發(fā)送垃圾郵件或存在異常的連接行為，被暫時(shí)掛起。請檢測發(fā)信IP在歷史上的發(fā)信情況和發(fā)信程序是否存在異常；

554 HL:IPB 該IP不在網(wǎng)易允許的發(fā)送地址列表里；

554 MI:STC 發(fā)件人當(dāng)天內(nèi)累計(jì)郵件數(shù)量超過限制，當(dāng)天不再接受該發(fā)件人的投信。請降低發(fā)信頻率；

554 MI:SPB 此用戶不在網(wǎng)易允許的發(fā)信用戶列表里；

554 IP in blacklist 該IP不在網(wǎng)易允許的發(fā)送地址列表里。

有任何問題私信小編！

pringBoot整合了Java Mail可以很方便的發(fā)送電子郵件。

我們來看看如何發(fā)送HTML格式的電子郵件。

導(dǎo)入郵件依賴

在SpringBoot的pom文件中導(dǎo)入電子郵件的starter。

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

配置郵件信息

在application.properties中配置郵箱信息，包括郵件服務(wù)器地址、用戶名和密碼。

spring.mail.host=smtp.qq.com
spring.mail.username=123@qq.com
spring.mail.password=456

注入郵件發(fā)送器

使用@Autowired注解注入JavaMailSender對(duì)象。

@Autowired
private JavaMailSender javaMailSender;

4.構(gòu)造HTML郵件

創(chuàng)建mimeMessage對(duì)象發(fā)送HTML郵件。

MimeMessage mimeMessage = javaMailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage);

try {
    helper.setFrom("123@qq.com(帥鍋)");
    helper.setTo("456@qq.com");
    helper.setSubject("你好");
    helper.setText("<a href='https://www.qq.com'>點(diǎn)我</a>",true);
} catch (MessagingException e) {
    e.printStackTrace();
}

通過MimeMessageHelper對(duì)象設(shè)置郵件信息。

setText第一個(gè)參數(shù)是郵件的正文，在這里輸入HTML代碼

setText第二個(gè)參數(shù)是設(shè)置是否是HTML郵件，要設(shè)置為true

方法	作用
helper.setFrom	設(shè)置發(fā)件人地址，可以通過“（）”設(shè)置別名
helper.setTo	設(shè)置收件人地址
helper.setSubject	設(shè)置郵件標(biāo)題
helper.setText	設(shè)置郵件正文，第二個(gè)參數(shù)設(shè)置是否為HTML郵件

發(fā)送郵件

通過 javaMailSender.send方法發(fā)送電子郵件，參數(shù)是構(gòu)建的mimeMessage對(duì)象。

@Component
public class MailServiceImpl implements MailService{

    @Autowired
    private JavaMailSender javaMailSender;

    @Override
    public void sendMail() {
        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage);

        try {
            helper.setFrom("123@qq.com(帥鍋)");
            helper.setTo("456@qq.com");
            helper.setSubject("你好");
            helper.setText("<a href='https://www.qq.com'>點(diǎn)我</a>",true);
        } catch (MessagingException e) {
            e.printStackTrace();
        }

        javaMailSender.send(mimeMessage);
    }
}

測試

通過測試方法測試郵件發(fā)送。

@SpringBootTest
public class MailTest {

    @Autowired
    private MailService mailService;

    @Test
    void test(){
        mailService.sendMail();
    }
}

郵箱收到了發(fā)送的郵件，連接是可以點(diǎn)擊的，是一個(gè)HTML格式的郵件。

avaMailSender是Spring Framework提供的一個(gè)接口，是Spring框架中用于發(fā)送電子郵件的核心接口，主要的作用就是用來簡化郵件在SpringBoot項(xiàng)目中的郵件發(fā)送的過程。它是基于JavaMail API封裝了一些常用的功能，使得開發(fā)者在SpringBoot項(xiàng)目中發(fā)送郵件信息變得高效快捷。

下面我們就來看看在SpringBoot中如何使用JavaMailSender來發(fā)送郵件。

添加配置

JavaMailSender接口由Spring Boot的spring-boot-starter-mail模塊提供實(shí)現(xiàn)。所以需要添加相關(guān)的POM依賴如下所示。

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

配置郵件服務(wù)器

在application.properties配置文件中添加郵件服務(wù)器信息配置，這個(gè)郵件服務(wù)器的相關(guān)信息，我們可以通過查找對(duì)應(yīng)的郵件服務(wù)操作來找到。

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=email@163.com
spring.mail.password=-password
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

創(chuàng)建配置類

當(dāng)然除了通過上面的配置文件的方式來進(jìn)行郵件發(fā)送服務(wù)的配置之外，我們還可以通過在SpringBoot中添加配置類的方式來對(duì)JavaMailSender的相關(guān)配置屬性進(jìn)行設(shè)置，如下所示。

@Configuration
public class MailConfig {

    @Bean
    public JavaMailSender getJavaMailSender() {
        JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
        mailSender.setHost("smtp.gmail.com");
        mailSender.setPort(587);

        mailSender.setUsername("your-email@163.com");
        mailSender.setPassword("email-password");

        Properties props = mailSender.getJavaMailProperties();
        props.put("mail.transport.protocol", "smtp");
        props.put("mail.smtp.auth", "true");
        props.put("mail.smtp.starttls.enable", "true");
        props.put("mail.debug", "true");

        return mailSender;
    }
}

創(chuàng)建郵件服務(wù)類

創(chuàng)建一個(gè)名為EmailService的類，用來進(jìn)行郵件的發(fā)送操作，方便在Controller層進(jìn)行調(diào)用。如下所示。

@Service
public class EmailService {

    @Autowired
    private JavaMailSender mailSender;

    public void sendSimpleEmail(String to, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setTo(to);
        message.setSubject(subject);
        message.setText(text);
        message.setFrom("email@163.com");

        mailSender.send(message);
    }
}

在這個(gè)服務(wù)中指定了郵件的發(fā)送者、發(fā)送主題、發(fā)送的內(nèi)容、以及發(fā)送的有郵箱等信息。接下來我們就來看看如何調(diào)用這個(gè)郵件發(fā)送服務(wù)。

使用郵件服務(wù)類發(fā)送郵件

在控制器類或其他服務(wù)類中注入這個(gè)郵件發(fā)送服務(wù)并且調(diào)用發(fā)送郵件的方法來進(jìn)行郵件的發(fā)送操作。

@RestController
public class EmailController {

    @Autowired
    private EmailService emailService;

    @GetMapping("/sendEmail")
    public String sendEmail(@RequestParam String to, @RequestParam String subject, @RequestParam String text) {
        emailService.sendSimpleEmail(to, subject, text);
        return "Email sent successfully";
    }
}

我們可以通過訪問http://localhost:8080/sendEmail?to=recipient@example.com&subject=Test&text=Hello的URL來發(fā)送測試郵件。

發(fā)送復(fù)雜郵件

當(dāng)然這個(gè)郵件只是一個(gè)簡單的文字類的郵件，如果我們想要發(fā)送更加復(fù)雜的收郵件的話可以修改郵件發(fā)送的方法，如下所示。

mport org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.mail.javamail.MimeMessagePreparator;

public void sendMimeEmail(String to, String subject, String htmlContent) {
    MimeMessagePreparator preparator = mimeMessage -> {
        MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage, true);
        messageHelper.setTo(to);
        messageHelper.setSubject(subject);
        messageHelper.setText(htmlContent, true);
        messageHelper.setFrom("email@163.com");
    };

    mailSender.send(preparator);
}

使用MimeMessage，來發(fā)送帶有HTML內(nèi)容或附件的郵件，下面這個(gè)展示了如何發(fā)送一個(gè)帶有附件的郵件。

import org.springframework.core.io.FileSystemResource;

public void sendEmailWithAttachment(String to, String subject, String text, String pathToAttachment) {
    MimeMessagePreparator preparator = mimeMessage -> {
        MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage, true);
        messageHelper.setTo(to);
        messageHelper.setSubject(subject);
        messageHelper.setText(text);
        messageHelper.setFrom("your-email@gmail.com");

        FileSystemResource file = new FileSystemResource(pathToAttachment);
        messageHelper.addAttachment(file.getFilename(), file);
    };

    mailSender.send(preparator);
}

注意

在實(shí)現(xiàn)郵件發(fā)送功能的時(shí)候要保證郵件配置的有效性，而對(duì)于如何找到上面的郵件配置，有興趣的讀者可以上網(wǎng)進(jìn)行搜索，基本上所有整合的方式都有，這里提供的是一個(gè)思路演示，但是代碼都是有效代碼。

其次要進(jìn)行復(fù)雜郵件內(nèi)容發(fā)送的時(shí)候，一定要注意對(duì)郵件中包含的內(nèi)容進(jìn)行校驗(yàn)避免出現(xiàn)跨站腳本攻擊、SQL注入、文件上傳等方面的漏洞保證系統(tǒng)的安全性。

總結(jié)

JavaMailSender使得在Spring應(yīng)用中發(fā)送郵件變得簡單和高效。通過配置郵件服務(wù)器、創(chuàng)建郵件服務(wù)類，并調(diào)用相應(yīng)的方法，可以方便地發(fā)送各種類型的郵件。

在線咨詢

上一篇：五種延遲加載圖像以提高網(wǎng)站性能的方法
下一篇：7個(gè)圖表小介紹，構(gòu)建交互式的最佳jquery圖表庫

您的項(xiàng)目需求

*請認(rèn)真填寫需求信息，我們會(huì)在24小時(shí)內(nèi)與您取得聯(lián)系。

整合營銷服務(wù)商