# mini-email-spring-boot-starter

**Repository Path**: php_siege_lion/mini-email-spring-boot-starter

## Basic Information

- **Project Name**: mini-email-spring-boot-starter
- **Description**: 将迷你又实用的 mini-email 封装成 starter，支持一键集成到 springboot2.x 和 springboot3.x，实现 springboot 自动装配。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2025-06-19
- **Last Updated**: 2025-06-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mini-email-spring-boot-starter

#### 介绍

将迷你又实用的 [mini-email](https://gitee.com/thundzeng/mini-email) 封装成 starter，支持一键集成到 springboot2.x 和 springboot3.x，实现 springboot 自动装配。

[![maven-central](https://img.shields.io/maven-central/v/io.github.thundzeng/mini-email-spring-boot-starter.svg?style=flat-square)](https://mvnrepository.com/artifact/io.github.thundzeng/mini-email-spring-boot-starter)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg?style=flat-square)](https://www.apache.org/licenses/LICENSE-2.0.html)

## 前言

- 必须使用 jdk1.8 及以上版本
- 若此项目你也在使用，请给项目一个 Star 或 Watch ，鼓励作者的同时还能收到最新的版本变更推送噢~
- 若对项目有任何疑问，可在 Issues 上新增 Issue，作者看到会第一时间查看和回复噢~
- 若你对项目有更好的功能或建设性代码，可从 fork mini-email-spring-boot-starter 的 master 分支到本地仓库，对代码更改完成后，再向 mini-email-spring-boot-starter 的 master 分支发起 pr。欢迎大家提交代码噢~
- 国内访问github受限，所以下面贴上 gitee 和 github 对应项目地址，大家各自选择。

  - gitee 项目地址：[点击跳转](https://gitee.com/thundzeng/mini-email-spring-boot-starter)
  - github 项目地址：等待补充。

## 使用方式

**引入maven坐标，版本号与 mini-email 版本号一致**

```xml
<dependency>
    <groupId>io.github.thundzeng</groupId>
    <artifactId>mini-email-spring-boot-starter</artifactId>
    <version>2.2.1_1</version>
</dependency>
```

**在application.yml文件中新增配置**

```yaml
## 配置 mini email 设置属性
mini-email:
  username: thundzeng@qq.com
  password: xxx
  sender-nickname: 五彩斑斓的黑
  smtp-host: smtp.qq.com
  smtp-port: 465
  mail-debug: false
  custom-mini-email:
  mail-smtp-auth: true
  mail-smtp-ssl-enable: true
  mail-smtp-timeout: 10000
```

**注：smtp-host 与 smtp-port 的枚举值可查看：io.github.thundzeng.miniemail.constant.SmtpHostEnum 枚举类。**

**finally 在需要使用邮件发送的地方注入MiniEmail，就可以愉快的食用啦！**

```java
@Autowired
private MiniEmail miniemail;

public String sendText(String to, String content) {
    String sendSuccessMail = miniEmail.send(to, content);

    return sendSuccessMail;
}
```

## 使用问题

若是在集成 mini-email 中遇到了问题，可以 [点击这里](https://gitee.com/thundzeng/mini-email/wikis/mini-email-starter%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98%26%E8%A7%A3%E5%86%B3%E6%96%B9%E6%B3%95) 寻找解决方案。若是记录中未能解决你的问题，可在下方中找到我的联系方式，把问题描述和对应报错信息发送到我邮箱，收到邮件后我会第一时间协助解决。

## 如何联系我

如果在使用过程中有任何疑问和建议，可通过邮箱方式联系我：

- 我的邮箱：`thundzeng@qq.com`

另外本人承接 H5、Web、小程序、App 定制开发，如有需要可通过以下方式联系我：

* 我的QQ（添加时备注：定制开发）：`1846316024`