Larch项目技术文档

1. 安装指南

Larch项目的最新稳定版本可以通过以下命令安装：

gem install larch

最新开发版本可以通过以下命令安装：

gem install larch --pre

确保你的系统中已经安装了Ruby环境以及gem包管理器。

2. 项目使用说明

Larch是一个命令行工具，用于快速、安全地将邮件从一个IMAP服务器复制到另一个。它的使用方法如下：

larch [config section] [options]
larch --from <uri> --to <uri> [options]

以下是可用选项的概述：

• --from, -f <s>: 源IMAP服务器的URI
• --from-folder, -F <s>: 源文件夹（默认为INBOX）
• --from-pass, -p <s>: 源服务器密码（默认提示输入）
• --from-user, -u <s>: 源服务器用户名（默认提示输入）
• --to, -t <s>: 目标IMAP服务器的URI
• --to-folder, -T <s>: 目标文件夹（默认为INBOX）
• --to-pass, -P <s>: 目标服务器密码（默认提示输入）
• --to-user, -U <s>: 目标服务器用户名（默认提示输入）

以及其他一些用于复制操作的选项。

使用示例

以下是一些如何使用Larch的示例：

• 基本使用：

larch --from imap://mail.example.com --to imap://imap.gmail.com

• 使用SSL连接：

larch --from imaps://mail.example.com --to imaps://imap.gmail.com

• 同步特定文件夹：

larch --from imaps://mail.example.com --to imaps://imap.gmail.com --from-folder 'Sent Mail' --to-folder 'Sent Mail'

• 同步所有文件夹：

larch --from imaps://mail.example.com --to imaps://imap.gmail.com --all

• 排除特定文件夹：

larch --from imaps://mail.example.com --to imaps://imap.gmail.com --all --exclude Spam Trash Drafts "[Gmail]/*"

3. 项目API使用文档

Larch主要通过命令行参数进行操作，不支持远程API调用。它的配置文件使用YAML格式，可以通过--config选项指定配置文件路径。

4. 项目安装方式

项目安装方式已在安装指南中说明，通过gem包管理器进行安装。

请确保在操作前仔细阅读了使用说明，并根据具体需求调整命令行参数。如果遇到任何问题，可以查看Larch的官方GitHub仓库获取更多信息。