Fake SMTP Server 教程

Fake SMTP Server 教程

1. 项目介绍

Fake SMTP Server 是一个专为开发者设计的简易电子邮件测试工具。它作为一个本地 SMTP 服务器运行，拦截应用程序发送到 "localhost" 的所有邮件，并在它的图形用户界面（GUI）中显示这些邮件。该项目基于 Java 实现，并使用了 SubEtha SMTP 库。它支持配置最大邮件存储数量，当达到上限时，旧邮件将被自动删除以避免内存占用过大。此外，Fake SMTP Server 还提供 Docker 镜像方便部署。

2. 项目快速启动

安装依赖

确保你的机器上已经安装了 Java 21 或更高版本。

本地运行

1. 克隆仓库：

   git clone https://github.com/gessnerfl/fake-smtp-server.git
   

2. 进入项目目录并构建：

   cd fake-smtp-server
   mvn install
   

3. 运行服务：

   java -jar target/fake-smtp-server.jar
   

默认情况下，SMTP 服务器将在端口 1025 上监听，HTTP 管理界面将在端口 1080 上监听。

使用 Docker

如果你更倾向于 Docker，可以执行以下命令来运行服务：

docker pull gessnerfl/fake-smtp-server
docker run -p 1025:1025 -p 1080:1080 -e MAX_EMAILS=100 gessnerfl/fake-smtp-server

这会将 SMTP 服务器绑定到主机的 1025 端口，HTTP 界面绑定到 1080 端口，并设置最大邮件数为 100。

3. 应用案例和最佳实践

• 软件开发：在开发阶段，Fake SMTP Server 可用于捕获应用程序发送的所有测试邮件，无需实际发送到真实收件人。
• 自动化测试：集成到自动化测试框架，验证发送邮件的逻辑是否正确。
• 教学示例：教育环境中演示电子邮件工作原理，学生可以在安全的环境中尝试发送邮件。

最佳实践包括：

1. 在不需要的时候停止服务，以节省系统资源。
2. 根据项目需求调整 MAX_EMAILS 环境变量，防止邮件堆积。
3. 利用 Docker 容器化特性，轻松在不同的开发或测试环境间迁移服务。

4. 典型生态项目

Fake SMTP Server 可与其他项目结合使用，如：

• CI/CD 工具：与 Jenkins、GitLab CI 等集成，测试阶段捕获邮件输出。
• 邮件客户端：配合 Thunderbird、Outlook 等，在本地查看接收到的测试邮件。
• 前端框架：在 Angular、React、Vue 等应用中，进行邮件发送功能的测试。

示例集成 Jenkins

在 Jenkins 脚本中添加如下步骤来启动 Fake SMTP Server 并检查邮件发送结果：

node {
    stage('Setup') {
        sh 'docker pull gessnerfl/fake-smtp-server'
    }
    stage('Test') {
        withEnv(['FAKE_SMTP_SERVER_MAX_EMAILS=100']) {
            def smtpServer = docker.image('gessnerfl/fake-smtp-server')
            smtpServer.run('-p 1025:1025 -p 1080:1080')
            
            // 执行你的测试任务，其中邮件会被 Fake SMTP Server 捕获
            
            smtpServer.stop()
            
            // 验证邮件发送情况
        }
    }
}

以上就是 Fake SMTP Server 的简单介绍以及如何启动和应用它。通过利用这个工具，你可以更加便捷地在开发和测试环境中处理电子邮件相关的功能。