# maddy-api

**Repository Path**: tangxi714/maddy-api

## Basic Information

- **Project Name**: maddy-api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-10
- **Last Updated**: 2025-04-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Maddy 邮件用户管理 API

## 快速开始

### 安装依赖
`npm install`

### 启动服务
`node .`
服务默认运行在 `http://localhost:8899`

# API 使用

 基本请求格式

所有请求需要包含 API 密钥参数:
```
/?key=你的API密钥&操作参数
```
 可用操作

| 操作 | 参数 | 示例 |
| :----: | :----: | :----: |
| 添加用户 | `add=用户名` | `/?key=xxx&add=newuser` |
| 删除用户 | `del=用户名` | `/?key=xxx&del=olduser` | 
| 列出用户 | `list=true` | `/?key=xxx&list=true` |

## 响应格式

成功响应:
```json
{
  "success": true,
  "data": {
    "count": 3,
    "users": "user1@domain.com", "user2@domain.com"
  }
}
```
## 命令行使用

```bash
 添加用户
node index.js add 用户名

 删除用户 
node index.js del 用户名

 列出用户
node index.js list
```
# 注意事项

- 首次运行会自动生成 `pass` 密钥文件
- 请妥善保管 API 密钥
- 需要 Node.js 16+ 环境