devbox
盐析白兔
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

springboot整合邮箱功能一(实战)_springboot 适配所有的邮箱

作者：盐析白兔 | 2024-02-16 16:53:42

赞

踩

springboot 适配所有的邮箱

背景介绍

邮件发送其实是一个非常常见的需求，用户注册，找回密码、校验码等地方。如果使用短信还需缴费。这里发送者邮箱选用了163邮箱。

1、pom.xml文件的引用

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  6.  
  7.     <parent>
  8.         <groupId>org.springframework.boot</groupId>
  9.         <artifactId>spring-boot-starter-parent</artifactId>
  10.         <!--<version>2.7.11</version>-->
  11.         <version>2.5.5</version>
  12.         <relativePath/> <!-- lookup parent from repository -->
  13.     </parent>
  14.     <properties>
  15.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  16.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  17.         <java.version>1.8</java.version>
  18.         <project-name>spring-boot-email</project-name>
  19.  
  20.         <maven.compiler.source>8</maven.compiler.source>
  21.         <maven.compiler.target>8</maven.compiler.target>
  22.     </properties>
  23.  
  24.     <groupId>org.example</groupId>
  25.     <artifactId>${project-name}</artifactId>
  26.     <version>1.0-SNAPSHOT</version>
  27.     <name>${project-name}</name>
  28.     <description>${project-name}</description>
  29.  
  30.     <dependencies>
  31.         <dependency>
  32.             <groupId>org.springframework.boot</groupId>
  33.             <artifactId>spring-boot-starter-mail</artifactId>
  34.         </dependency>
  35.  
  36.         <dependency>
  37.             <groupId>org.springframework.boot</groupId>
  38.             <artifactId>spring-boot-starter-test</artifactId>
  39.             <scope>test</scope>
  40.         </dependency>
  41.  
  42.         <dependency>
  43.             <groupId>org.springframework.boot</groupId>
  44.             <artifactId>spring-boot-starter-web</artifactId>
  45.         </dependency>
  46.  
  47.         <!-- ================= 应用 ================== -->
  48.         <!-- thymeleaf模板 -->
  49.         <dependency>
  50.             <groupId>org.springframework.boot</groupId>
  51.             <artifactId>spring-boot-starter-thymeleaf</artifactId>
  52.             <!--<version>2.3.12.RELEASE</version>-->
  53.         </dependency>
  54.  
  55.         <dependency>
  56.             <groupId>com.alibaba.fastjson2</groupId>
  57.             <artifactId>fastjson2</artifactId>
  58.             <version>2.0.25</version>
  59.         </dependency>
  60.  
  61.         <dependency>
  62.             <groupId>org.apache.commons</groupId>
  63.             <artifactId>commons-lang3</artifactId>
  64.         </dependency>
  65.  
  66.         <dependency>
  67.             <groupId>com.google.guava</groupId>
  68.             <artifactId>guava</artifactId>
  69.             <version>31.1-android</version>
  70.         </dependency>
  71.     </dependencies>
  72.  
  73.     <build>
  74.         <plugins>
  75.             <plugin>
  76.                 <groupId>org.springframework.boot</groupId>
  77.                 <artifactId>spring-boot-maven-plugin</artifactId>
  78.                 <version>2.7.1</version>
  79.                 <configuration>
  80.                     <excludes>
  81.                         <exclude>
  82.                             <groupId>org.projectlombok</groupId>
  83.                             <artifactId>lombok</artifactId>
  84.                         </exclude>
  85.                     </excludes>
  86.                 </configuration>
  87.             </plugin>
  88.         </plugins>
  89.     </build>
  90. </project>

2、yml配置文件中的配置

  1. server:
  2.   port: 8000
  3.   max-http-header-size: 8192
  4.   servlet:
  5.     encoding:
  6.       charset: UTF-8
  7.       force: true
  8.       enabled: true
  9.  
  10. #配置日志
  11. logging:
  12.   level:
  13.     root: info
  14. spring:
  15.   application:
  16.     name: spring-boot-email
  17.   mvc.async.request-timeout: 20000
  18.  
  19.   mail:
  20.     #    host: "smtp.163.com" # 发件服务器地址
  21.     #    port: 25 # 常用邮件端口25、109、110、143、465、995、993、994 如果开启了SSL安全则使用对应的端口号，25为非加密端口号
  22.     #    username: admin@163.com # 发送邮件的账号
  23.     #    password: 123456 # 配置密码，注意，不是真正的密码，而是刚刚申请到的授权码
  24.     #    default-encoding: utf-8 # 设置编码
  25.     host: smtp.exmail.qq.com
  26.     port: 465
  27.     username: admin@xxx.cn
  28.     password: 123123
  29.     default-encoding: utf-8 # 设置编码
  30.     protocol: smtp
  31.     properties: # 设置邮件超时时间防止服务器阻塞
  32.       timeout: 5000
  33.       connection-timeout: 5000
  34.       write-timeout: 5000
  35.       mail:
  36.         debug: true # 表示开启 DEBUG 模式，这样，邮件发送过程的日志会在控制台打印出来，方便排查错误
  37.         # 官方建议使用 465 端口，而 465 端口是 SSL 协议的，所以不仅要换端口，
  38.         # 还需要进行 SSL 协议替换。下面是在 application.properties 进行的邮件发送相关配置，
  39.         smtp:
  40.           socketFactory:
  41.             port: 465
  42.           #socketFactoryClass: javax.net.ssl.SSLSocketFactory #配饰 SSL 加密工厂
  43.           ssl:
  44.             enable: true

3、EmailController

  1. package org.example.controller;
  2.  
  3. import org.example.entity.EmailModel;
  4. import org.example.service.EmailService;
  5. import org.slf4j.Logger;
  6. import org.slf4j.LoggerFactory;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.web.bind.annotation.PostMapping;
  9. import org.springframework.web.bind.annotation.RequestBody;
  10. import org.springframework.web.bind.annotation.RequestMapping;
  11. import org.springframework.web.bind.annotation.RestController;
  12.  
  13. import javax.mail.MessagingException;
  14.  
  15. /**
  16.  * @description:
  17.  */
  18. @RestController
  19. public class EmailController {
  20.     Logger log = LoggerFactory.getLogger(getClass());
  21.  
  22.     @Autowired
  23.     EmailService emailService;
  24.  
  25.     @PostMapping("sendModleMail")
  26.     public String sendModleMail(@RequestBody EmailModel model) throws MessagingException {
  27.         emailService.sendModleMail(model);
  28.         return "success!";
  29.     }
  30. }

4、EmailService

  1. package org.example.service;
  2.  
  3. import org.example.entity.EmailModel;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  6. import org.springframework.beans.factory.annotation.Value;
  7. import org.springframework.mail.javamail.JavaMailSender;
  8. import org.springframework.mail.javamail.MimeMessageHelper;
  9. import org.springframework.scheduling.annotation.EnableAsync;
  10. import org.springframework.stereotype.Service;
  11.  
  12. import javax.annotation.Resource;
  13. import javax.mail.MessagingException;
  14. import javax.mail.internet.MimeMessage;
  15. import java.io.File;
  16. import java.util.Date;
  17.  
  18. /**
  19.  * @author Administrator
  20.  */
  21. @Service
  22. @EnableAsync
  23. public class EmailService {
  24.     Logger log = LoggerFactory.getLogger(getClass());
  25.  
  26.     /**
  27.      * 发送者邮箱
  28.      */
  29.     @Value("${spring.mail.username}")
  30.     public String MAIL_USERNAME;
  31.  
  32.     /**
  33.      * JavaMailSender类的对象,是springboot自动装配的
  34.      */
  35.     @Resource
  36.     private JavaMailSender javaMailSender;
  37.  
  38.     public void sendModleMail(EmailModel model) throws MessagingException {
  39.         MimeMessage mimeMessage = javaMailSender.createMimeMessage();
  40.         MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
  41.         helper.setSubject(model.getSubject()); // 邮件标题
  42.         helper.setFrom(MAIL_USERNAME); // 发送者邮箱
  43.         helper.setTo(model.getRecipientMailbox()); // 收件人邮箱
  44.         if (model.getCcMailbox() != null && model.getCcMailbox().length != 0) {
  45.             helper.setCc(model.getCcMailbox()); // 抄送人
  46.         }
  47.         if (model.getBccMailbox() != null && model.getBccMailbox().length != 0) {
  48.             helper.setBcc(model.getBccMailbox()); // 加密抄送
  49.         }
  50.         helper.setSentDate(new Date()); // 发送日期
  51.         helper.setText(model.getSendContent()); // 发送内容
  52.         if (!model.getEnclosures().isEmpty()) {
  53.             log.info("-------[Iterator循环遍历]通过keySet取出map数据---------");
  54.             for (String key : model.getEnclosures().keySet()) {
  55.                 helper.addAttachment(key, new File(model.getEnclosures().get(key)));// 预览文件
  56.                 // System.out.println("key值："+key+" value值："+model.getEnclosures().get(key));
  57.             }
  58.  
  59.         }
  60.         // helper.addAttachment("2.jpg", new File("E:\\pic\\2.jpg"));//预览文件
  61.         //        helper.addInline("p01",new FileSystemResource(new File("E:\\pic\\2.jpg")));//配合前端可以直接预览图片
  62.         //        helper.addInline("p02",new FileSystemResource(new File("E:\\pic\\2.jpg")));
  63.         javaMailSender.send(mimeMessage);
  64.     }
  65. }

5、创建发送邮箱EmailModel

  1. package org.example.entity;
  2.  
  3. /**
  4.  * @author 86133 2023-05-08 10:52:59
  5.  */
  6.  
  7. import java.io.Serializable;
  8. import java.util.Map;
  9.  
  10. public class EmailModel implements Serializable {
  11.     /**
  12.      * 邮件主题
  13.      */
  14.     private String subject;
  15.  
  16.     /**
  17.      * 收件人邮箱
  18.      */
  19.     private String[] recipientMailbox;
  20.  
  21.     /**
  22.      * 抄送人邮箱
  23.      */
  24.     private String[] ccMailbox;
  25.  
  26.     /**
  27.      * 加密抄送人邮箱
  28.      */
  29.     private String[] bccMailbox;
  30.  
  31.     /**
  32.      * 发送内容
  33.      */
  34.     private String sendContent;
  35.  
  36.     /**
  37.      * 真实名称/附件路径
  38.      */
  39.     private Map<String, String> enclosures;
  40.  
  41.     //    附件是否添加的到正文,默认false不添加
  42.     //    private Boolean is_;
  43.  
  44.  
  45.     public String getSubject() {
  46.         return subject;
  47.     }
  48.  
  49.     public void setSubject(String subject) {
  50.         this.subject = subject;
  51.     }
  52.  
  53.     public String[] getRecipientMailbox() {
  54.         return recipientMailbox;
  55.     }
  56.  
  57.     public void setRecipientMailbox(String[] recipientMailbox) {
  58.         this.recipientMailbox = recipientMailbox;
  59.     }
  60.  
  61.     public String[] getCcMailbox() {
  62.         return ccMailbox;
  63.     }
  64.  
  65.     public void setCcMailbox(String[] ccMailbox) {
  66.         this.ccMailbox = ccMailbox;
  67.     }
  68.  
  69.     public String[] getBccMailbox() {
  70.         return bccMailbox;
  71.     }
  72.  
  73.     public void setBccMailbox(String[] bccMailbox) {
  74.         this.bccMailbox = bccMailbox;
  75.     }
  76.  
  77.     public String getSendContent() {
  78.         return sendContent;
  79.     }
  80.  
  81.     public void setSendContent(String sendContent) {
  82.         this.sendContent = sendContent;
  83.     }
  84.  
  85.     public Map<String, String> getEnclosures() {
  86.         return enclosures;
  87.     }
  88.  
  89.     public void setEnclosures(Map<String, String> enclosures) {
  90.         this.enclosures = enclosures;
  91.     }
  92. }

注意：收件人，抄送人，加密抄送人，都可以多个。附件的发送附件的位置需要和项目在同一台服务器上。

6、调用该方法

  1.     @PostMapping("/sendMail")
  2.     public ResultJson sendMail(@RequestBody SendMailModel model) throws MessagingException {
  3.         sendMailUtil.sendMail(model);
  4.         return ResultJson.SUCCESS();
  5.     }

7、使用postMan测试该方法请求的参数

  1. {
  2.     "subject": "测试主题",
  3.     "recipientMailbox": [
  4.         "666666@qq.com",
  5.         "test@test.cn"
  6.     ],
  7.     "ccMailbox": ["6666666@163.com"],
  8.     "bccMailbox": [],
  9.     "sendContent": "测试邮件测试人test",
  10.     "enclosures": {
  11.         "dog2.jpg": "E:\\123\\img\\dog2.png"
  12.     }
  13. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/盐析白兔/article/detail/95367
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号