happydomain/happydeliver

happyDeliver - 邮件送达性测试平台 📨

一个开源的自托管邮件送达性测试平台，可分析测试邮件并提供带评分的详细送达报告，帮助用户优化邮件配置以提升送达率。

---

🧩 核心功能

• 全维度邮件分析：覆盖SPF、DKIM、DMARC、BIMI、ARC、SpamAssassin、DNS、黑名单、内容及邮件头检查
• REST API支持：轻松创建测试任务和获取报告结果
• LMTP服务器集成：无缝对接现有邮件传输代理（MTA）
• 智能评分系统：基于加权因素给出A→F的等级评分
• 灵活存储选项：支持SQLite或PostgreSQL数据库
• 可配置性强：通过环境变量或配置文件自定义参数

---

🚀 快速开始（推荐）

一体化Docker镜像包含所有必要组件：Postfix MTA（端口25）、authentication_milter、SpamAssassin、happyDeliver API（端口8080）、SQLite持久化存储。

使用Docker Compose运行

bash
git clone https://git.nemunai.re/happyDomain/happyDeliver.git
cd happyDeliver

# 编辑docker-compose.yml设置你的域名
# 修改HAPPYDELIVER_DOMAIN和HOSTNAME变量

docker-compose up -d

访问方式：

• API：http://localhost:8080
• SMTP：localhost:25

直接使用Docker运行

bash
docker run -d \
  --name happydeliver \
  -p 25:25 \
  -p 8080:8080 \
  -e HAPPYDELIVER_DOMAIN=yourdomain.com \
  -e HOSTNAME=mail.yourdomain.com \
  -v $(pwd)/data:/var/lib/happydeliver \
  -v $(pwd)/logs:/var/log/happydeliver \
  docker.xuanyuan.run/happydeliver:latest

---

🌐 网络与DNS配置

开放SMTP端口（25）

bash
sudo ufw allow 25/tcp
# 或
sudo iptables -A INPUT -p tcp --dport 25 -j ACCEPT

⚠️ 注意：部分云服务商默认屏蔽25端口，需申请解除限制。

DNS记录示例

yourdomain.com. IN A 203.0.113.10
yourdomain.com. IN AAAA 2001:db8::10

若同一主机同时提供HTTP和SMTP服务，无需额外配置MX记录。

---

🧪 API使用示例

创建测试示例：

bash
curl -X POST http://localhost:8080/api/test

响应：

json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "test-kfauqaao@localhost",
  "status": "pending"
}

---

🧰 CLI模式使用

手动分析邮件文件：

bash
cat email.eml | ./happyDeliver analyze

指定收件人分析：

bash
cat email.eml | ./happyDeliver analyze -recipient test@yourdomain.com

---

📊 评分标准

---

⚖️ 许可证

GNU Affero通用公共许可证v3.0或更高版本（AGPL-3.0-or-later）

---

🐳 Docker标签说明

---

源码地址： git.nemunai.re/happyDomain/happyDeliver