kabbageinc/kalemail

Kalemail

Kalemail是一款邮件服务器镜像，能够以可测试、可搜索的方式保存收到的邮件，支持原始邮件格式查看及Email on Acid集成，适用于开发测试场景下的邮件验证需求。

核心功能

• 捕获并存储incoming邮件，提供原始格式查看能力
• 支持邮件搜索，方便快速定位目标内容
• 集成Email on Acid服务，实现邮件多客户端兼容性的石蕊测试
• 支持邮件转发至下游SMTP服务器，留存副本用于审计或分析

使用场景

• 开发/测试环境：验证应用发送的邮件内容、格式是否符合预期
• 邮件模板测试：通过Email on Acid检查模板在不同***客户端的显示效果
• 邮件中间件：作为中转服务器，转发邮件的同时保存副本用于后续排查

配置说明

数据库初始化

使用scripts/sql/db-init.sql脚本初始化MySQL数据库及所需表；或通过docker-compose up启动应用与数据库容器，需创建kalemail-db.env（配置MySQL环境变量）和kalemail.env（配置应用环境变量）。

关键环境变量

数据库配置

DB_HOST=MySQL主机地址
DB_PORT=数据库端口（默认3306）
DB_DATABASE=数据库名称（如kalemail）
DB_USER=数据库用户名
DB_PASSWORD=数据库密码

S3存储配置

S3_BUCKET=S3桶名称
S3_FOLDER=桶内可选子文件夹
# AWS凭证（三选一）：IAM角色/标准密钥/S3专用密钥
AWS_ACCESS_KEY_ID=访问密钥（标准密钥方式）
AWS_SECRET_ACCESS_KEY=秘密密钥（标准密钥方式）
S3_ACCESS=S3访问密钥（专用方式）
S3_SECRET=S3秘密密钥（专用方式）
S3_REGION=区域（如us-east-1）

Email on Acid集成

EOAAPI=EmailOnAcid API密钥
EOAPASS=EmailOnAcid账户密码

邮件转发配置

FORWARD={"host":"下游SMTP服务器地址","port":端口号,"secure":true/false}

部署示例

Docker Compose部署

1. 创建kalemail-db.env：

MYSQL_ROOT_PASSWORD=root123
MYSQL_DATABASE=kalemail
MYSQL_USER=kalemail_user
MYSQL_PASSWORD=user123

2. 创建kalemail.env：

DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=kalemail
DB_USER=kalemail_user
DB_PASSWORD=user123
S3_BUCKET=my-test-bucket
S3_REGION=us-east-1

3. 编写docker-compose.yml：

yaml
version: '3'
services:
  mysql:
    image: mysql:8.0
    env_file: kalemail-db.env
    volumes:
      - mysql-data:/var/lib/mysql
    networks:
      - kalemail-net
  kalemail:
    image: kabbageinc/kalemail
    env_file: kalemail.env
    ports:
      - "3000:3000" # Web界面
      - "25:25"      # SMTP端口
    depends_on:
      - mysql
    networks:
      - kalemail-net
volumes:
  mysql-data:
networks:
  kalemail-net:

4. 启动服务：docker-compose up -d

手动启动（非Compose）

1. 克隆项目并安装依赖：npm i
2. 构建代码：npm run gulp
3. 设置环境变量后启动：npm start，访问http://localhost:3000查看邮件列表