cliffordw/mailcatcher

MailCatcher 容器镜像

镜像概述和主要用途

MailCatcher 容器镜像是一个轻量级的容器化解决方案，用于运行 MailCatcher 工具。MailCatcher 是一款面向开发和测试的工具，它提供了一个简单的 SMTP 服务器，能够捕获所有发送至其端口的邮件消息，并通过 Web 界面直观展示这些消息内容。该镜像简化了 MailCatcher 的部署流程，无需手动配置依赖环境，即可快速搭建邮件捕获与查看服务。

核心功能和特性

• 简易 SMTP 服务器：运行轻量级 SMTP 服务，接收并捕获所有发送至其端口的邮件，无需实际发送至外部***
• Web 界面展示：提供直观的 Web 界面，可查看捕获邮件的主题、发件人、收件人、内容（含原始数据和格式化视图）
• 轻量级设计：镜像体积小巧，资源占用低，适合开发环境快速部署
• 零配置启动：默认配置下无需额外参数，启动即可使用核心功能
• 跨平台兼容：可在任何支持 Docker 的环境中运行，包括本地开发机、虚拟机和容器编排平台

使用场景和适用范围

主要适用场景

• 应用邮件功能开发：在开发阶段测试应用程序的邮件发送逻辑，验证邮件内容、格式、模板是否正确
• 前端/后端联调：前端触发邮件发送后，可立即在 Web 界面查看结果，快速定位问题
• 自动化测试环境：在 CI/CD 流程中作为测试环节的邮件服务器，确保邮件功能在自动化测试中可验证
• 教学演示：演示邮件发送流程时，无需配置真实邮件服务，避免垃圾邮件产生

适用人群

• 软件开发工程师（后端/全栈）
• QA 测试工程师
• 教学人员和学生

使用方法和配置说明

镜像获取

该镜像托管于 GitHub Container Registry，可通过以下命令拉取：

bash
docker pull ghcr.io/clifford2/mailcatcher

基本运行命令

使用 docker run 启动容器，需映射 SMTP 端口（默认 1025）和 Web 端口（默认 1080）：

bash
docker run -d -p 1025:1025 -p 1080:1080 --name mailcatcher ghcr.io/clifford2/mailcatcher

参数说明：

• -d：后台运行容器
• -p 1025:1025：映射 SMTP 服务端口（主机端口:容器端口）
• -p 1080:1080：映射 Web 界面端口（主机端口:容器端口）
• --name mailcatcher：指定容器名称，便于后续管理

访问 Web 界面

容器启动后，通过浏览器访问以下地址即可查看捕获的邮件：

http://localhost:1080

应用程序配置示例

在开发的应用程序中，将邮件发送配置指向 MailCatcher：

示例（Python 应用配置）

python
# Django 邮件配置示例
EMAIL_HOST = 'localhost'
EMAIL_PORT = 1025
EMAIL_HOST_USER = ''  # 无需认证
EMAIL_HOST_PASSWORD = ''  # 无需认证
EMAIL_USE_TLS = False

示例（Node.js 应用配置）

javascript
// Nodemailer 配置示例
const transporter = nodemailer.createTransport({
  host: 'localhost',
  port: 1025,
  secure: false, // 不需要 TLS
  tls: {
    rejectUnauthorized: false // 开发环境禁用证书验证
  }
});

自定义端口配置

如需修改默认端口，可通过命令行参数指定。例如，将 SMTP 端口改为 2525，Web 端口改为 8080：

bash
docker run -d -p 2525:2525 -p 8080:8080 --name mailcatcher ghcr.io/clifford2/mailcatcher --smtp-port 2525 --http-port 8080

Docker Compose 配置示例

在多容器开发环境中，可通过 docker-compose.yml 集成 MailCatcher：

yaml
version: '3'
services:
  app:
    build: .
    depends_on:
      - mailcatcher
    environment:
      - SMTP_HOST=mailcatcher
      - SMTP_PORT=1025
  
  mailcatcher:
    image: ghcr.io/clifford2/mailcatcher
    ports:
      - "1080:1080"  # Web 界面端口映射到主机
    # SMTP 端口仅需内部访问，无需映射到主机

查看捕获的邮件

容器启动后，访问 http://localhost:1080（或自定义的 Web 端口）即可打开 MailCatcher Web 界面，查看所有捕获的邮件列表及详情。

更多资源

• 官方文档：[***]
• 镜像源代码和详细使用说明：https://github.com/clifford2/mailcatcher