Larch 项目使用教程

Larch 项目使用教程

larch :skull: Larch copies messages from one IMAP server to another. No longer maintained. 项目地址: https://gitcode.com/gh_mirrors/la/larch

1. 项目的目录结构及介绍

Larch 项目的目录结构如下：

larch/
├── bin/
│   └── larch
├── lib/
│   ├── larch/
│   │   ├── ...
│   └── ...
├── test/
│   ├── ...
│   └── ...
├── .gitignore
├── Gemfile
├── Gemfile.lock
├── HISTORY
├── LICENSE
├── README.rdoc
├── Rakefile
└── larch.gemspec

目录结构介绍

• bin/: 包含可执行文件 larch，用于启动 Larch 工具。
• lib/: 包含 Larch 的核心代码库，包括各种模块和功能实现。
• test/: 包含测试文件，用于测试 Larch 的功能和稳定性。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• Gemfile: 定义了项目所需的 RubyGems 依赖。
• Gemfile.lock: 锁定 Gemfile 中定义的依赖版本。
• HISTORY: 记录项目的更新历史。
• LICENSE: 项目的开源许可证文件。
• README.rdoc: 项目的说明文档。
• Rakefile: 用于定义项目的 Rake 任务。
• larch.gemspec: 项目的 gemspec 文件，定义了 gem 的元数据和依赖。

2. 项目的启动文件介绍

Larch 的启动文件位于 bin/ 目录下，文件名为 larch。该文件是一个可执行脚本，用于启动 Larch 工具。

启动文件介绍

• bin/larch: 这是一个 Ruby 脚本，用于启动 Larch 工具。它负责解析命令行参数，加载配置文件，并调用 Larch 的核心功能模块来执行邮件复制任务。

3. 项目的配置文件介绍

Larch 的配置文件默认位于 ~/larch/config.yaml，用户可以通过 --config 选项指定自定义的配置文件路径。

配置文件介绍

配置文件是一个 YAML 文件，包含多个配置节（section），每个节定义了一组特定的配置选项。以下是一个示例配置文件：

default:
  all-subscribed: true  # 默认复制所有订阅的文件夹

# 从 Gmail 复制邮件到我的服务器，排除不需要的文件夹
gmail to my server:
  from: imaps://imap.gmail.com
  from-user: example
  from-pass: secret
  to: imaps://mail.example.com
  to-user: example
  to-pass: secret
  exclude:
    - "[Gmail]/Sent Mail"
    - "[Gmail]/Spam"
    - "[Gmail]/Trash"

# 从我的 INBOX 复制邮件到 Gmail 的 INBOX
my inbox to gmail inbox:
  all-subscribed: false
  from: imaps://mail.example.com
  from-folder: INBOX
  from-user: example
  from-pass: secret
  to: imaps://imap.gmail.com
  to-folder: INBOX
  to-user: example
  to-pass: secret

配置文件结构

• default: 默认配置节，包含所有其他节共享的配置选项。
• gmail to my server: 定义了从 Gmail 复制邮件到自定义服务器的配置。
• my inbox to gmail inbox: 定义了从自定义服务器的 INBOX 复制邮件到 Gmail 的 INBOX 的配置。

配置选项

• from: 源 IMAP 服务器的 URI。
• from-user: 源服务器的用户名。
• from-pass: 源服务器的密码。
• to: 目标 IMAP 服务器的 URI。
• to-user: 目标服务器的用户名。
• to-pass: 目标服务器的密码。
• exclude: 排除的文件夹列表。

通过配置文件，用户可以灵活地定义不同的邮件复制任务，并根据需要调整配置选项。

larch :skull: Larch copies messages from one IMAP server to another. No longer maintained. 项目地址: https://gitcode.com/gh_mirrors/la/larch