MiniSmtpServer 技术文档

1. 安装指南

MiniSmtpServer 是一个作为 RubyGem 打包的轻量级 SMTP 服务器。安装非常简单，只需在命令行中运行以下命令：

gem install mini-smtp-server

确保你的系统中已经安装了 Ruby 环境。

2. 项目使用说明

MiniSmtpServer 设计用于被集成到其他系统中，以决定如何处理接收到的邮件。默认情况下，它作为一个“黑洞”，不对接收到的邮件做任何处理。

运行默认服务器

要运行默认服务器，请使用以下代码：

# 创建一个新的服务器实例，监听 127.0.0.1:2525 地址，并最多接受 4 个并发连接
server = MiniSmtpServer.new(2525, "127.0.0.1", 4)

# 启动服务器
server.start

# ...
# 处理请求并进行其他工作
# ...

# 不中断任何连接的情况下关闭服务器
server.shutdown
while(server.connections > 0)
  sleep 0.01
end
server.stop
server.join

服务器自定义

MiniSmtpServer 通过子类化易于自定义。只需继承 MiniSmtpServer 类并重新定义 new_message_event 事件处理程序：

# 这是一个将接收到的所有邮件日志输出到 STDOUT 的 SMTP 服务器
class StdoutSmtpServer < MiniSmtpServer

  def new_message_event(message_hash)
    puts "# 新邮件接收："
    puts "-- 发件人: #{message_hash[:from]}"
    puts "-- 收件人: #{message_hash[:to]}"
    puts "--"
    puts "-- " + message_hash[:data].gsub(/\r\n/, "\r\n-- ")
    puts
  end

end

然后创建一个新的服务器实例并像平常一样运行：

server = StdoutSmtpServer.new
server.start
server.join

自定义的可能性是无穷的，且易于实现！例如，如果你希望所有电子邮件存储到数据库中：

class DatabaseSmtpServer < MiniSmtpServer
  def new_message_event(message_hash)
    # 假设我们有一个名为 'Email' 的 ActiveRecord 模型
    Email.create(message_hash)
  end
end

3. 项目API使用文档

目前 MiniSmtpServer 不提供详细的 API 文档。但是，你可以通过阅读源代码和查看示例来了解如何使用它的方法和事件。

4. 项目安装方式

项目的安装方式已在安装指南中详细说明，即通过 RubyGem 进行安装。

以上就是 MiniSmtpServer 的技术文档。希望对你有所帮助！