# temp-mail

**Repository Path**: gptzm/temp-mail

## Basic Information

- **Project Name**: temp-mail
- **Description**: 一个简单的临时邮箱服务，可以快速生成临时邮箱地址并接收邮件。
- **Primary Language**: NodeJS
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2024-11-10
- **Last Updated**: 2025-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 临时邮箱服务

一个简单的临时邮箱服务，不需要注册就可以快速生成临时邮箱地址并接收邮件。

![临时邮箱界面截图](./screenshot/demo.png)

## 功能特点


邮箱管理:
- 一键生成随机邮箱地址,方便快捷
- 智能记忆功能，自动保存上次使用的邮箱，下次访问直接加载

邮件监控:
- 智能监控机制，新建邮箱后前5分钟每5秒检查一次
- 5分钟后自动切换为每分钟检查一次，降低服务器压力
- DEBUG模式下，支持发送测试邮件验证邮箱是否正常工作

邮件查看:
- 支持多种格式查看邮件内容，包括HTML格式、纯文本以及原始邮件内容，但不支持预览附件
- 实时更新显示最新邮件，收到新邮件自动刷新

其他特性:
- 兼容多种SMTP服务端口
- 自动清理7天前的过期邮件，保持系统整洁
- 增量获取新邮件，提升系统效率

## 技术栈

- 前端: handlebars
- 后端: Node.js + Express
- 数据库: Sqlite3
- 邮件服务: SMTP

## 快速开始

### 环境要求

- Node.js >= 20
- `TEMPEMAIL_SMTP_PORTS`: SMTP 服务端口，默认 "25,465,587,2525"
- `TEMPEMAIL_SMTP_DEFAULT_PORT`: 默认 SMTP 端口，默认 465
- `TEMPEMAIL_SMTP_DOMAIN`: SMTP 域名，默认 "localhost"
- `TEMPEMAIL_SMTP_PROTOCOL`: SMTP 协议，默认 "smtp"
- `TEMPEMAIL_HTTP_PORT`: HTTP 服务端口，默认 3000
- `TEMPEMAIL_HTTP_DOMAIN`: SMTP 域名，默认 "localhost"
- `TEMPEMAIL_HTTP_PROTOCOL`: HTTP 协议，默认 "http"

### 安装步骤

1. 克隆项目
```bash
git clone https://gitee.com/gptzm/temp-mail.git
cd temp-mail
```

2. 安装依赖
```bash
npm install
```

3. 配置环境变量
```bash
cp .env.example .env
```
编辑 .env 文件，配置数据库等信息

4. 启动服务端
```bash
npm run start     # 启动服务端
# npm run debug   # 启动服务端并打开调试模式
```

5. 发送测试邮件
```bash
npm run test-smtp
```


## 使用说明

1. 访问服务地址，默认 `http://localhost:3000`
2. 点击"生成随机邮箱"或输入指定邮箱地址
3. 点击"开始自动监控"即可接收邮件
4. 可随时点击"立即收取"手动检查新邮件
5. 点击"发送测试邮件"可测试邮箱是否正常工作

## 开源协议

本项目采用 GPL 协议开源，详见 [LICENSE](./LICENSE) 文件。

## 联系我们

- 项目地址：[https://gitee.com/gptzm/temp-mail](https://gitee.com/gptzm/temp-mail)
- 问题反馈：[Issues](https://gitee.com/gptzm/temp-mail/issues)

## 致谢

感谢所有为本项目做出贡献的开发者！