easyengine/mailhog

EasyEngine Mail (MailHog) 镜像文档

镜像概述和主要用途

EasyEngine Mail镜像基于MailHog构建，是一个轻量级电子邮件测试工具镜像。主要用于开发和测试环境中捕获应用程序发送的所有传出电子邮件，提供Web界面和API以便查看、测试邮件内容，无需配置真实SMTP服务器或发送邮件至真实***地址，有效避免测试邮件干扰真实用户。

核心功能和特性

• 邮件捕获：拦截所有通过SMTP协议发送的电子邮件，支持标准SMTP接口
• Web界面：提供直观的Web UI（默认端口8025），可查看、搜索、预览捕获的邮件内容及附件
• API支持：提供REST API，便于自动化测试和集成到CI/CD流程
• 轻量级设计：基于Go语言开发，资源占用低，启动快速
• 灵活存储：支持内存或文件系统存储邮件数据，满足不同测试场景需求
• Docker原生集成：适配Docker环境，可直接通过Docker命令或docker-compose快速部署

使用场景和适用范围

• 开发环境测试：本地开发网站、应用时，测试用户注册邮件、密码重置邮件、通知邮件等功能
• CI/CD流程验证：自动化测试中验证邮件发送逻辑，确保应用在不同场景下能正确生成和发送邮件
• 团队协作测试：开发团队共享测试环境时，集中查看应用发送的邮件内容，便于问题定位
• 第三方服务集成测试：测试与邮件相关的第三方服务（如邮件模板、变量替换）时，捕获完整邮件内容进行校验

详细使用方法和配置说明

基本部署（Docker Run）

通过以下命令快速启动MailHog容器：

bash
docker run -d \
  --name easyengine-mail \
  -p 1025:1025 \  # SMTP服务端口（应用需配置SMTP服务器为该端口）
  -p 8025:8025 \  # Web界面端口（访问http://localhost:8025查看邮件）
  easyengine/mail

Docker Compose配置示例

在docker-compose.yml中集成：

yaml
version: '3'
services:
  mail:
    image: docker.xuanyuan.run/easyengine/mail
    ports:
      - "1025:1025"  # SMTP端口
      - "8025:8025"  # Web UI端口
    restart: unless-stopped
    # 可选：持久化存储邮件（默认内存存储，容器重启后数据丢失）
    volumes:
      - ./mail-data:/mailhog/data  # 将邮件数据存储到本地目录

核心配置参数

通过环境变量自定义MailHog行为（添加到docker run -e或docker-compose的environment中）：

应用配置示例

将应用的SMTP服务器配置指向MailHog容器，例如：

• SMTP服务器：easyengine-mail（Docker网络内）或localhost（宿主机）
• SMTP端口：1025
• 无需用户名/密码（除非配置了MH_AUTH_FILE）

发送邮件后，访问http://localhost:8025即可在Web界面查看所有捕获的邮件。

构建状态