Mailman 技术文档

本文档旨在帮助用户了解并使用 Mailman 项目，内容包括安装指南、使用说明以及项目API使用文档。

1. 安装指南

Mailman 是一个用于处理 incoming 邮件的微框架，支持 POP3 和 Maildir，并且可以与 Rails 无缝集成。

安装方式

在您的项目 Gemfile 中添加以下代码：

gem 'mailman'

然后执行以下命令安装依赖：

bundle install

兼容性

Mailman 已经在以下 Ruby 版本上进行测试：2.1, 2.0, 1.9.3, JRuby 和 Rubinius。

对于 Ruby < 2.0.0

如果您希望将此 gem 用于 Ruby 2.0.0 以下版本，您需要在 Gemfile 中限制 maildir gem 到最新支持的版本：

gem 'maildir', '< 2.1.0'

2. 项目使用说明

以下是一个简单的 Mailman 应用示例，它将收到的支持邮件添加到数据库中：

require 'mailman'

Mailman::Application.run do
  to '[e-mail]' do
    Ticket.new_from_message(message)
  end
end

启动 Mailman 应用，只需运行以下命令：

ruby mailman_app.rb

更多详细信息，请参考 用户指南。

注意：该项目已不再维护。

3. 项目API使用文档

Mailman 提供了灵活的路由和条件系统，允许您根据消息的不同部分（如收件人、发件人和主题）来定义处理逻辑。

路由和条件

• 条件：用于指定消息中需要匹配的部分，如 to、from 和 subject。
• 匹配器：用于确定条件是否匹配消息，可以是字符串或正则表达式。

以下是一个定义路由的示例：

Mailman::Application.run do
  to '[e-mail]' do
    Ticket.find(params[:id]).add_reply(message)
  end
end

匹配器类型

• 字符串：搜索字段中的特定子串。
• 正则表达式：用于更复杂的匹配逻辑。
• 头部信息：可以匹配消息头部信息，如 To、From 和 Subject。

参数和捕获

您可以使用 params 助手或块参数来访问捕获的数据。

Mailman::Application.run do
  to '[e-mail]' do
    user = User.find_by_username(params[:username])
    user.process_message(message)
  end
end

4. 项目安装方式

Mailman 的安装方式已在第1节中详细说明，请参考上述步骤进行安装。