richarvey/mailhog

MailHog 镜像文档

镜像概述和主要用途

MailHog是一款面向开发者的邮件测试工具，旨在帮助开发者在不发送真实邮件的情况下测试应用的邮件发送功能。通过配置应用使用MailHog作为SMTP服务器，开发者可以捕获、查看和管理测试邮件，避免向真实用户发送测试邮件。此镜像支持多架构，可在不同平台上无缝运行。

核心功能和特性

• SMTP投递测试：配置应用使用MailHog作为SMTP服务器，捕获所有出站邮件
• 多方式查看邮件：通过Web UI直观查看邮件内容，或通过JSON API检索邮件数据
• 邮件转发功能：可选将捕获的邮件释放到真实SMTP服务器进行实际投递
• 轻量级设计：采用内存存储消息，无需持久化，适合开发环境使用

使用场景和适用范围

• 开发环境邮件测试：本地开发时测试应用邮件发送功能，避免向真实用户发送测试邮件
• CI/CD流程集成：在持续集成/部署流程中验证邮件发送逻辑是否正常工作
• 应用邮件配置调试：调试SMTP配置、邮件模板渲染等问题，快速定位异常
• 教学和演示：展示邮件发送流程，无需配置真实邮件服务器

使用方法和配置说明

默认配置

MailHog镜像默认使用以下配置：

• SMTP服务器：监听端口1025
• HTTP服务器（Web UI和API）：监听端口8025
• 消息存储：采用内存存储，容器重启后消息将丢失

基本使用（Docker Run）

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

bash
docker run -d -p 1025:1025 -p 8025:8025 --name mailhog mailhog/mailhog

• -p 1025:1025：映射SMTP端口，供应用连接发送邮件
• -p 8025:8025：映射HTTP端口，通过浏览器访问Web UI（访问 http://localhost:8025）
• --name mailhog：指定容器名称，便于管理

查看邮件

启动容器后，通过浏览器访问 http://localhost:8025 即可打开MailHog的Web UI，查看所有捕获的邮件。

通过API检索邮件

MailHog提供JSON API用于检索邮件，例如：

• 获取所有邮件：GET http://localhost:8025/api/v2/messages
• 获取特定邮件详情：GET http://localhost:8025/api/v2/messages/{messageID}

邮件转发配置（可选）

如需将捕获的邮件转发到真实SMTP服务器，可通过环境变量配置，例如：

bash
docker run -d -p 1025:1025 -p 8025:8025 \
  -e MH_SMTP_RELAY_HOST=smtp.example.com \
  -e MH_SMTP_RELAY_PORT=587 \
  -e MH_SMTP_RELAY_USER=user@example.com \
  -e MH_SMTP_RELAY_PASS=password \
  --name mailhog mailhog/mailhog

以上配置将使MailHog在接收到邮件后，转发到指定的SMTP服务器。