SpringBoot学习记录----发送各种类型的邮件

秒速五厘米 2022-01-09 12:43 90阅读 0赞

前段时间要做一个通过邮件重置找回用户密码的的功能，现在抽空把之前网上找到的资料总结一下。我们可以通过SpringBoot发送普通邮件，带附件邮件，或者是图文邮件。实现的方法大同小异。该教程包括发送普通邮件，带HTML邮件，图文邮件，以及附件邮件。直接上教程：

### 1、准备工作 ###

我们发送邮件基本是通过各邮箱的POP3/SMTP/IMAP服务，因此我们在发送邮件前需要开启邮件发送账号的POP3/SMTP/IMAP服务。下面以QQ邮箱为例。

登录QQ邮箱后进入账户页面：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70][]

开启POP3/SMTP/IMAP服务。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70 1][]

在开启后需要验证账号信息，验证通过后悔生成授权码，这个后面开发配置的时候需要。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70 2][]

### 2、开发环境配置 ###

本文是默认会创建基本的SpringBoot框架，本文采用yaml配置文件。

配置文件很简单，只需要加入下面代码：

spring:
      mail:
        #QQ邮箱服务器地址
        host: smtp.qq.com
        #刚刚的授权码 
        password: tjpwogliyXXXXX
        #授权码对应的邮箱账号
        username: 3577XXXXX@qq.com

在pom.xml中加入：

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

### 3、启动类 ###

SpringBoot最基本的启动类：

package czz.study.sendemail;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    /**
     * 用于发送邮件的demo
     *
     * @author chenzhengzhou
     * @version 1.0
     * @date 2019/6/22 10:40
     */
    @SpringBootApplication
    public class SendEmailApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SendEmailApplication.class, args);
        }
    
    }

### 4、业务代码 ###

我是直接把业务代码和控制层写在一起，实际开发时建议解耦

package czz.study.sendemail.api;
    
    import lombok.AllArgsConstructor;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.core.io.FileSystemResource;
    import org.springframework.mail.SimpleMailMessage;
    import org.springframework.mail.javamail.JavaMailSender;
    import org.springframework.mail.javamail.MimeMessageHelper;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.mail.internet.MimeMessage;
    import java.io.File;
    
    /**
     * 发送邮件Api
     *
     * @author chenzhengzhou
     * @version 1.0
     * @date 2019/6/20 23:34
     */
    @RestController
    @RequestMapping("/send")
    @AllArgsConstructor
    public class SendMail {
    
        private final JavaMailSender mailSender;
    
        /**
         * 发送普通邮件
         *
         * @return 发送结果
         */
        @RequestMapping("/commonMail")
        public String commonMail() {
            //创建要发送的邮件实体
            SimpleMailMessage message = new SimpleMailMessage();
            //发件人
            message.setFrom("3577XXXXX@qq.com");
            // 收件人,如果发送多个人，用数组来表示
            // String[] array = new String[]    {"sun111@163.com","sun222@sohu.com"};
            // mailMessage.setTo(array);
            message.setTo("3577XXXXX@qq.com");
            //主题
            message.setSubject("SpringBoot发送普通邮件");
            //正文
            message.setText("hello world!!");
            mailSender.send(message);
            System.out.println("普通邮件发送成功");
            return "ok";
        }
    
        /**
         * 发送HTML邮件
         *
         * @return 发送结果
         */
        @RequestMapping("/htmlMail")
        public String htmlMail() {
            //创建要发送的邮件实体
            MimeMessage message = mailSender.createMimeMessage();
            try {
                //创建数据填充器，这个true代表是否创建支持替代文本、内联元素和附件的多功能消息
                MimeMessageHelper helper = new MimeMessageHelper(message, true);
                //发件人
                helper.setFrom("3577XXXXX@qq.com");
    
                // 收件人,如果发送多个人，用数组来表示
                // String[] array = new String[]    {"sun111@163.com","sun222@sohu.com"};
                // mailMessage.setTo(array);
                helper.setTo("3577XXXXX@qq.com");
                //主题
                helper.setSubject("SpringBoot发送HTML邮件");
                //这里可以传入HTML语句，可以添加跳转链接等,镶嵌图片教程在下面这个方法
                String html = "<html>\n" +
                        "<body>\n" +
                        "<h1>HTML邮件标签</h1>" +
                        "<p>HTML邮件发送成功</p>" +
                        "</body>\n" +
                        "</html>";
                helper.setText(html, true);
                mailSender.send(message);
    
            } catch (Exception e) {
                throw new RuntimeException("邮件发送失败");
            }
            System.out.println("HTML邮件发送成功");
    
            return "ok";
        }
    
        /**
         * 发送带图片邮件
         *
         * @return 发送结果
         */
        @RequestMapping("/pictureMail")
        public String pictureMail() {
            //创建要发送的邮件实体
            MimeMessage message = mailSender.createMimeMessage();
            try {
                //创建数据填充器，这个true代表是否创建支持替代文本、内联元素和附件的多功能消息
                MimeMessageHelper helper = new MimeMessageHelper(message, true);
                //发件人
                helper.setFrom("3577XXXXX@qq.com");
    
                // 收件人,如果发送多个人，用数组来表示
                // String[] array = new String[]    {"sun111@163.com","sun222@sohu.com"};
                // mailMessage.setTo(array);
                helper.setTo("3577XXXXX@qq.com");
                //主题
                helper.setSubject("SpringBoot发送图文邮件");
    
                //true 表示启动HTML格式的邮件
                helper.setText("<h1>发送带图片的HTML</h1><img src='cid:aaaa'/>", true);
                //指定要内联的文件
                FileSystemResource img = new FileSystemResource(new File("C:\\Users\\czz\\Desktop\\11.png"));
                //将文件和HTML内联
                helper.addInline("aaaa", img);
                mailSender.send(message);
    
            } catch (Exception e) {
                throw new RuntimeException("邮件发送失败");
            }
            System.out.println("图片邮件发送成功");
    
            return "ok";
        }
    
        /**
         * 发送带附件邮件
         *
         * @return 发送结果
         */
        @RequestMapping("/attachmentMail")
        public String attachmentMail() {
            //创建要发送的邮件实体
            MimeMessage message = mailSender.createMimeMessage();
            try {
                //创建数据填充器，这个true代表是否创建支持替代文本、内联元素和附件的多功能消息
                MimeMessageHelper helper = new MimeMessageHelper(message, true);
                //发件人
                helper.setFrom("3577XXXXX@qq.com");
    
                // 收件人,如果发送多个人，用数组来表示
                // String[] array = new String[]    {"sun111@163.com","sun222@sohu.com"};
                // mailMessage.setTo(array);
                helper.setTo("3577XXXXX@qq.com");
                //主题
                helper.setSubject("SpringBoot发送附件邮件");
                //正文
                helper.setText("发送附件");
                FileSystemResource attachment = new FileSystemResource(new File("C:\\Users\\czz\\Desktop\\11.png"));
    
                helper.addAttachment(attachment.getFilename(), attachment);
                mailSender.send(message);
    
            } catch (Exception e) {
                throw new RuntimeException("邮件发送失败");
            }
            System.out.println("附件邮件发送成功");
    
            return "ok";
        }
    }

### 5、功能测试 ###

在浏览器中分别输入以下请求。查看是否能够接受邮件

//发送普通邮件
    http://127.0.0.1:8080/send/commonMail
    //发送HTML邮件
    http://127.0.0.1:8080/send/htmlMail
    //发送图文邮件
    http://127.0.0.1:8080/send/pictureMail
    //发送带附件邮件
    http://127.0.0.1:8080/send/attachmentMail

github地址：[https://github.com/sumuchenshang/send-email.git][https_github.com_sumuchenshang_send-email.git]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70]: /images/20220109/33c92e83d37c45f498875bad47d887df.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70 1]: /images/20220109/e404933ece494903b78d75b30a4aa1f9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW56ejI1NjA_size_16_color_FFFFFF_t_70 2]: /images/20220109/3bacafebe0ee4638ac130569b08e797b.png
[https_github.com_sumuchenshang_send-email.git]: https://github.com/sumuchenshang/send-email.git