fake-smtp-server Docker镜像文档

镜像概述

fake-smtp-server是一款专为开发和测试场景设计的轻量级SMTP服务器镜像。它通过内存数据库存储接收的邮件，并提供Web界面直观查看邮件内容，解决了开发过程中测试邮件发送功能需依赖外部邮件服务的痛点，无需配置真实邮件服务器即可完成邮件功能验证。

核心功能与特性

• 内存数据存储：邮件数据仅保存在内存中，服务重启后自动清除，避免测试数据残留，适合开发环境临时使用
• Web管理界面：内置Web界面，可实时查看所有接收邮件的详细信息（发件人、收件人、主题、内容、附件等）
• 标准SMTP协议支持：兼容SMTP标准协议，可无缝对接各类邮件客户端和应用程序
• 轻量级设计：镜像体积小，资源占用低，启动速度快，适合本地开发和CI/CD测试环境集成
• 灵活配置：支持通过环境变量自定义端口、日志级别等核心参数，适配不同测试场景

使用场景与适用范围

• 开发环境邮件功能测试：开发人员本地调试邮件发送逻辑，无需配置外部SMTP服务
• 自动化测试集成：单元测试、集成测试中验证邮件发送功能，确保邮件内容和格式正确性
• 演示与教学场景：产品演示或教学活动中展示邮件发送流程，无需真实邮件账号
• 离线开发环境：无网络环境下测试邮件功能，不依赖外部服务可用性

使用方法

快速启动（Docker Run）

通过以下命令启动基础服务，映射SMTP端口（默认25）和Web界面端口（默认8080）：

docker run -d \
  -p 25:25 \  # SMTP服务端口映射
  -p 8080:8080 \  # Web界面端口映射
  --name fake-smtp-server \
  gessnerfl/fake-smtp-server

服务启动后，访问 http://localhost:8080 即可打开Web管理界面查看接收的邮件。

自定义配置（环境变量）

通过环境变量调整服务参数，例如修改端口或日志级别：

docker run -d \
  -p 2525:2525 \  # 自定义SMTP端口（主机:容器）
  -p 8081:8081 \  # 自定义Web端口（主机:容器）
  -e SMTP_PORT=2525 \  # 容器内SMTP服务端口
  -e WEB_PORT=8081 \  # 容器内Web服务端口
  -e LOG_LEVEL=DEBUG \  # 日志级别（DEBUG/INFO/WARN/ERROR）
  --name fake-smtp-server \
  gessnerfl/fake-smtp-server

Docker Compose配置

创建 docker-compose.yml 文件集成到项目中：

version: '3.8'
services:
  fake-smtp:
    image: gessnerfl/fake-smtp-server
    ports:
      - "25:25"
      - "8080:8080"
    environment:
      - SMTP_PORT=25
      - WEB_PORT=8080
      - LOG_LEVEL=INFO
    restart: unless-stopped  # 确保服务持续运行

启动服务：

docker-compose up -d

配置参数说明

Web界面使用

服务启动后，通过 http://<主机IP>:<WEB_PORT> 访问Web界面，功能包括：

• 查看所有接收邮件列表（按时间倒序）
• 查看单封邮件详情（原始内容、HTML预览、附件下载）
• 批量/单个删除邮件
• 邮件搜索（按发件人、收件人、主题关键词）

注意事项

• 该镜像仅用于开发和测试目的，禁止用于生产环境发送真实邮件
• 默认配置下数据不持久化，重启容器后所有邮件数据将丢失
• 若需持久化数据，需启用 PERSISTENCE_ENABLED=true 并挂载数据卷（具体配置参见官方文档）
• 生产环境需使用正规邮件服务（如SendGrid、SMTP服务器），本镜像不提供邮件转发功能