droptica/maildev

MailDev 镜像文档

镜像概述

MailDev 是一款面向开发环境的邮件测试工具，旨在帮助开发者在不发送真实邮件的情况下测试应用的邮件功能。它提供内置的SMTP服务器用于接收邮件，并通过Web界面直观展示所有发送的邮件内容，支持预览、查看邮件详情及管理操作，是开发阶段邮件功能调试的理想工具。

核心功能和特性

• SMTP服务器：内置轻量级SMTP服务器，可接收应用发送的邮件，无需配置外部邮件服务。
• Web界面：提供简洁的Web界面，可实时查看所有接收的邮件，支持HTML/文本格式预览、附件查看。
• 邮件管理：支持删除单封或全部邮件，便于测试流程中快速清理测试数据。
• 灵活配置：可通过环境变量自定义SMTP端口、Web端口、访问认证等参数。
• API支持：提供REST API，可通过编程方式获取或删除邮件，便于集成到自动化测试流程。

使用场景和适用范围

• Web应用开发：测试用户注册验证邮件、密码重置邮件、通知邮件等功能。
• 自动化测试：配合CI/CD流程，验证邮件发送逻辑是否正常。
• 开发团队协作：共享邮件测试环境，团队成员可通过Web界面共同查看测试邮件。
• 本地调试：替代真实邮件服务，避免开发过程中误发邮件至真实用户。

使用方法和配置说明

基本使用（Docker Run）

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

bash
docker run -d -p 1080:1080 -p 25:25 --name maildev djfarrelly/maildev

• -p 1080:1080：映射Web界面端口（主机端口:容器端口）
• -p 25:25：映射SMTP服务端口
• --name maildev：指定容器名称为maildev

环境变量配置

可通过-e参数设置环境变量自定义配置：

示例（自定义端口与认证）：

bash
docker run -d \
  -p 8080:8080 -p 587:587 \
  -e SMTP_PORT=587 \
  -e WEB_PORT=8080 \
  -e WEB_USER=dev \
  -e WEB_PASS=test123 \
  --name maildev djfarrelly/maildev

Docker Compose配置

在docker-compose.yml中集成MailDev：

yaml
version: '3'
services:
  maildev:
    image: djfarrelly/maildev
    ports:
      - "1080:1080"  # Web界面
      - "25:25"      # SMTP端口
    environment:
      - SMTP_PORT=25
      - WEB_PORT=1080
    restart: unless-stopped  # 容器退出时自动重启（可选）

启动命令：docker-compose up -d

访问Web界面

容器启动后，通过浏览器访问 http://localhost:1080（默认端口）打开Web界面，即可查看所有发送至MailDev SMTP服务器的邮件。若配置了认证，需输入WEB_USER和WEB_PASS登录。

应用配置示例（以SMTP客户端为例）

在开发应用中，将SMTP服务器配置为MailDev容器的地址和端口，例如：

• SMTP服务器：localhost（或容器IP）
• SMTP端口：25（默认，或自定义端口）
• 无需认证（默认配置下）

发送测试邮件后，即可在Web界面实时查看邮件内容。