IMAPFilter 技术文档

1. 安装指南

环境要求

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

• Lua 编程语言版本 5.4 或 5.3 或 5.2 或 5.1
• PCRE2 库版本 10.00 或更高
• OpenSSL 库版本 1.0.2 或更高

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/lefcha/imapfilter.git
   

2. 进入项目目录，编译并安装程序：

   cd imapfilter
   make -j all
   make install
   

3. 确保安装后的程序可以在命令行中执行 imapfilter 命令。

2. 项目的使用说明

IMAPFilter 是一款邮件过滤工具，支持通过 Internet Message Access Protocol (IMAP) 连接到远程邮件服务器，向服务器发送搜索查询并基于结果处理邮箱。它可以用来删除、复制、移动、标记等位于同一或不同邮件服务器上的邮箱中的邮件。

命令行选项

详细的命令行选项描述可以在 imapfilter(1) 手册页中找到。

配置文件

配置文件格式在 imapfilter_config(5) 手册页中有详细描述。

配置示例

项目中提供了配置示例，位于 samples/config.lua 文件中。

3. 项目API使用文档

IMAPFilter 使用 Lua 编程语言作为配置和扩展语言。您可以通过 Lua 脚本来编写自定义的配置和扩展功能。

扩展示例

扩展示例位于 samples/extend.lua 文件中。

4. 项目安装方式

如前所述，IMAPFilter 的安装方式如下：

1. 确保系统满足环境要求。
2. 克隆项目到本地。
3. 编译并安装程序。

以上为 IMAPFilter 的技术文档，希望对您使用和理解本项目有所帮助。