FakeSMTP 技术文档

1. 安装指南

在开始使用 FakeSMTP 前，请确保您的计算机上已安装 Java JVM 1.6 或更高版本。对于类 Unix 系统（如 Mac、GNU/Linux、BSD 等），您可能需要以 root 用户身份启动以使用端口 25，或者选择使用大于 1024 的其他端口。

2. 项目使用说明

FakeSMTP 是一个带有图形用户界面的免费伪造 SMTP 服务器，用于在应用程序中轻松测试电子邮件。以下是使用说明：

• 直接双击 fakeSMTP.jar 文件或在命令行中执行以下命令启动程序：

  java -jar fakeSMTP-VERSION.jar
  

• 若要指定启动应用程序时保存电子邮件的目录，可以使用 -o 参数：

  java -jar fakeSMTP-VERSION.jar -o 输出目录名
  

• 若要自动启动 SMTP 服务器，可以使用 -s 参数：

  java -jar fakeSMTP-VERSION.jar -s
  

• 若要后台运行 SMTP 服务器，不显示 GUI，并绑定到回环地址上的不同端口，可以使用以下参数：

  java -jar fakeSMTP-VERSION.jar -s -b -p 2525 -a 127.0.0.1
  

• 若不需要将电子邮件保存到文件系统（以提高性能），可以使用 -m 参数（内存模式）：

  java -jar fakeSMTP-VERSION.jar -m
  

• 若要查看所有可用选项（中继域、自定义 eml 查看器等），可以使用 --help 参数。

3. 项目API使用文档

当前项目中并未提供特定的 API 文档。FakeSMTP 的主要功能是通过命令行参数进行配置和使用。

4. 项目安装方式

通过 Maven 构建

要构建 FakeSMTP，您需要下载并设置 Maven。安装 Maven 后，导航到项目目录并执行以下命令：

mvn package -Dmaven.test.skip

此命令将在 target 文件夹中创建一个可执行 jar 文件。建议不要跳过单元测试。

使用 Docker

您可以使用 Docker 来运行 FakeSMTP。

• 运行分布式版本

  docker build -t="mail" github.com/Nilhcem/FakeSMTP
  docker run -ti -p 250:25 --privileged=true -v /mail:/output mail
  

• 从源代码构建

  克隆 GitHub 仓库：

  git clone https://github.com/Nilhcem/FakeSMTP
  cd FakeSMTP
  

  构建 Docker 镜像：

  mvn package docker:build -DskipTests
  

  运行 Docker 镜像：

  docker run -ti -d fakesmtp
  

  配置容器：

  • 将 SMTP 端口 25 映射到主机端口。
  • 将邮件存储卷映射到主机目录。

  完整命令：

  docker run -ti -d -p 250:25 --privileged=true -v /home/fakesmtp/mail:/output fakesmtp
  

如需进一步的帮助或有任何疑问，请通过我的 GitHub 昵称联系我。