Qpsmtpd 项目技术文档

1. 安装指南

1.1 环境准备

在安装 Qpsmtpd 之前，请确保您的系统满足以下要求：

• Perl 版本至少为 5.8.0。
• 安装所需的 Perl 模块：
  • Net::DNS
  • MIME::Base64
  • Mail::Header（来自 MailTools 发行版）

如果您的 Perl 版本低于 5.8.0，还需要安装以下模块：

• Data::Dumper
• File::Temp
• Time::HiRes

1.2 安装 Perl 模块

使用 CPAN 安装所需的 Perl 模块：

perl -MCPAN -e shell

在 CPAN shell 中，输入以下命令安装模块：

install Net::DNS
install MIME::Base64
install Mail::Header

如果需要，还可以安装其他依赖模块。

1.3 安装 Qpsmtpd

1. 创建一个新的用户和目录来安装 Qpsmtpd。通常使用 smtpd 作为用户名，并将目录设置为 /home/smtpd/qpsmtpd/。
2. 从 GitHub 克隆 Qpsmtpd 项目：

   git clone git://github.com/smtpd/qpsmtpd.git
   

3. 如果需要特定版本，可以使用以下命令切换到指定版本：

   git checkout -b local_branch v0.93
   

4. 设置目录权限：

   chmod o+t /home/smtpd/qpsmtpd/
   

5. 编辑 config/IP 文件，设置 Qpsmtpd 使用的 IP 地址（或使用 0 绑定到所有接口）。

1.4 启动 Qpsmtpd

如果使用 supervise 工具，只需将 /home/smtpd/qpsmtpd 链接到 /services 目录即可。如果不使用 supervise，则需要手动运行 ./run 脚本。

2. 项目的使用说明

2.1 配置文件

Qpsmtpd 的配置文件可以放在 /var/qmail/control 或 config 子目录中。配置应与 qmail-smtpd 兼容，以便 Qpsmtpd 可以作为其替代品。

2.2 插件系统

Qpsmtpd 的核心仅实现 SMTP 协议，所有功能都通过插件实现。插件在启动时加载，并注册对各种“钩子”的兴趣。至少需要一个插件来允许或拒绝 RCPT 命令，以启用邮件接收。

2.3 日志记录

默认情况下，Qpsmtpd 将日志记录到 log/main/current。可以通过调整 config/loglevel 文件中的数字来控制日志的详细程度。

3. 项目API使用文档

3.1 插件API

Qpsmtpd 的插件系统非常灵活，允许开发者轻松扩展功能。每个插件都可以注册对特定“钩子”的兴趣，并在适当的时候执行相应的操作。

3.2 配置API

Qpsmtpd 支持多种配置文件，包括：

• plugins：列出要加载的插件。
• rhsbl_zones：右侧阻止列表。
• dnsbl_zones：基于 IP 的 DNS 阻止列表。
• spool_dir：指定 spool 目录。
• spool_perms：设置 spool 目录的权限。
• tls_before_auth：控制 AUTH 是否需要 TLS/SSL。

4. 项目安装方式

4.1 从 Git 安装

通过 Git 克隆项目并切换到特定版本：

git clone git://github.com/smtpd/qpsmtpd.git
git checkout -b local_branch v0.93

4.2 使用 Supervise 启动

如果使用 supervise 工具，只需将项目目录链接到 /services 目录即可。

4.3 手动启动

如果不使用 supervise，可以手动运行 ./run 脚本来启动 Qpsmtpd。

通过以上步骤，您可以成功安装并配置 Qpsmtpd，开始使用其强大的 SMTP 功能。