oryd/mailslurper

MailSlurper 镜像文档

概述和主要用途

MailSlurper 是一个轻量级 SMTP 邮件服务器镜像，旨在帮助开发人员和小型团队测试邮件功能。它可以捕获发送的邮件并存储到数据库中，无需配置完整的邮件服务器，避免了测试过程中发送真实邮件的风险和复杂性，方便开发人员随时查看和验证邮件内容。

核心功能和特性

• 轻量级 SMTP 服务器：无需复杂配置即可快速运行，搭建测试环境简单
• 邮件捕获与存储：将所有发送到该服务器的邮件捕获并存储到数据库中
• Web 界面查看：提供直观的 Web 界面，方便开发人员查看、管理捕获的邮件
• 安全测试环境：避免向真实***发送测试邮件，保护数据安全和隐私
• 易于集成：可轻松配置应用程序或服务器将邮件发送到 MailSlurper

使用场景和适用范围

• 个人开发者：测试邮件发送功能（如通知邮件、注册验证邮件等）
• 小型开发团队：团队协作开发中统一测试邮件功能
• CI/CD 流程：在持续集成/部署过程中自动化测试邮件发送功能
• 教学与演示：学习邮件服务器工作原理或演示邮件功能时使用

使用方法和配置说明

基本使用（Docker Run）

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

bash
docker run -d -p 25:25 -p 8080:8080 --name mailslurper docker.xuanyuan.run/mailslurper/mailslurper

参数说明：

• -p 25:25：映射 SMTP 服务端口，应用程序通过此端口发送邮件
• -p 8080:8080：映射 Web 界面端口，通过浏览器访问查看邮件
• --name mailslurper：指定容器名称，便于管理

Docker Compose 配置

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  mailslurper:
    image: docker.xuanyuan.run/mailslurper/mailslurper
    ports:
      - "25:25"    # SMTP 服务端口
      - "8080:8080" # Web 界面端口
    restart: always
    volumes:
      - ./data:/app/data  # 挂载数据目录，持久化存储邮件数据库

启动容器：

bash
docker-compose up -d

配置参数

可通过环境变量调整 MailSlurper 行为，常见配置参数：

示例：自定义端口和日志级别

bash
docker run -d \
  -p 2525:2525 \
  -p 8081:8081 \
  -e SMTP_PORT=2525 \
  -e WEB_PORT=8081 \
  -e LOG_LEVEL=debug \
  --name mailslurper docker.xuanyuan.run/mailslurper/mailslurper

查看捕获的邮件

启动容器后，通过浏览器访问 http://localhost:8080（或自定义 Web 端口），进入 MailSlurper Web 界面，可查看所有捕获的邮件，包括发件人、收件人、主题、内容等详细信息。

依赖和 credits

该镜像基于 MailSlurper 项目构建，使用了多个开源库和框架，包括 BlockUI、Bootstrap、jQuery、Echo、Logrus 等（完整列表参见项目原文档）。

许可证

MailSlurper 遵循 MIT 许可证，详细信息参见项目原文档。