tempalias技术文档

1. 安装指南

在开始使用tempalias项目前，您需要确保已经安装了以下依赖：

• 足够新版本的Node.js（当前至少需要0.1.99版本）
• 足够新版本的Redis（推荐2.0 rc1版本）用于别名存储
• 一个无需认证即可中转邮件到任何地址的SMTP智能主机

安装步骤如下：

1. 克隆项目仓库
2. 初始化git子模块：git submodule update --init
3. 将config.ini.template复制为config.ini并根据您的需求进行编辑
4. 在项目根目录运行node tempalias.js

2. 项目的使用说明

项目启动后，将会在本地启动一个Web服务器（默认监听8080端口）和一个SMTP代理（默认监听2525端口）。Web前端和WebService端点都可通过http://localhost:8080/访问。

您可以通过查看public/jslib/app.js来了解WebService的工作方式，或者使用curl进行以下操作：

curl --no-keepalive -H "Content-Type: application/json" \
  --data-binary '{"target": "[e-mail]","days": 3,"max-usage": 5}'\
  -qsS http://localhost:8080/aliases

上述命令将创建一个指向[e-mail]的邮件别名，该别名在3天后过期或者使用5次后失效。

3. 项目API使用文档

项目的API接口可以通过HTTP POST请求发送JSON数据到http://localhost:8080/aliases来创建邮件别名。以下是请求的JSON格式：

{
  "target": "目标邮箱地址",
  "days": 生命周期天数（可选）,
  "max-usage": 最大使用次数（可选）
}

创建成功后，系统将返回一个邮件别名的地址。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细介绍，主要包括：

1. 克隆仓库
2. 初始化子模块
3. 配置项目
4. 运行项目

确保在运行之前，所有依赖都已正确安装，并且SMTP智能主机配置正确。

---

本文档介绍了tempalias项目的安装、使用和API调用方法，帮助用户更好地了解和使用该项目。