# hello_email_tool

**Repository Path**: lisbitid/hello_email_tool

## Basic Information

- **Project Name**: hello_email_tool
- **Description**: • 这是一个极简的邮件发送服务，优点就是可以把SMTP发送转成API接口发送，兼容不支持SMTP的客户端• 提供简单的邮件记录与统计功能，可以知道发送了什么邮件、发了多少邮件、发送成功与失败• 支持Docker一键部署，轻量内存占用低，低配置，易于集成• 适合作为一个开发测试协助工具，发送一些告警信息等
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-05
- **Last Updated**: 2026-01-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Email Tool

基于 Gin 框架的邮件发送服务

## 安装

```bash
go mod tidy
```

## 配置

复制 `.env.example` 为 `.env` 并修改配置：

```bash
cp .env.example .env
```

主要配置项：

```env
# SMTP 邮件配置
SMTP_HOST=smtp.example.com
SMTP_PORT=465
SMTP_USERNAME=your_email@example.com
SMTP_PASSWORD=your_password
SMTP_FROM=your_email@example.com
SMTP_FROM_NAME=EmailTool

# 邮件接口授权码
EMAIL_AUTH_CODE=your_auth_code
```

## 运行

```bash
# 直接运行
go run main.go serve

# 热重载运行
gin serve run main.go
```

## API 接口

### 发送邮件

**请求地址：** `/api/email`

**请求方式：** `GET` / `POST`

**请求参数：**

| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| auth_code | string | 是 | 授权码，需与环境变量 EMAIL_AUTH_CODE 一致 |
| to | string | 是 | 收件人，多个用逗号分隔 |
| cc | string | 否 | 抄送人，多个用逗号分隔 |
| subject | string | 是 | 邮件主题 |
| body | string | 是 | 邮件正文 |
| is_html | bool | 否 | 是否为 HTML 格式，支持 `1`/`true` |
| from_name | string | 否 | 发件人名称，默认使用环境变量 SMTP_FROM_NAME |

**请求示例：**

GET 请求：
```
/api/email?auth_code=xxx&to=test@qq.com&subject=测试邮件&body=邮件内容&is_html=1
```

POST 请求：
```json
{
  "auth_code": "xxx",
  "to": "test@qq.com,test2@qq.com",
  "cc": "cc@qq.com",
  "subject": "测试邮件",
  "body": "<h1>HTML内容</h1>",
  "is_html": true,
  "from_name": "自定义发件人"
}
```

**响应示例：**

成功：
```json
{
  "code": 200,
  "data": [],
  "message": "邮件发送成功"
}
```

失败：
```json
{
  "code": 400,
  "data": [],
  "msg": "授权码错误"
}
```