Gmvault 使用与技术文档

1. 安装指南

下载安装

您可以从 Gmvault 官方网站 下载适合您操作系统的二进制分布版本。

• Windows: 下载安装程序后，运行 gmvault-shell.bat 脚本（桌面上有快捷方式）以设置环境。
• Linux 和 Mac OS X: 解压二进制发行版的 tarball 包，并进入 GMVAULT_HOME/bin 目录以运行 gmvault。

从源代码安装

您也可以从 GitHub 上的源代码安装 Gmvault。

• 从源代码安装: 在源代码目录中运行 python setup.py install。
• 从 PyPi 安装: 使用 pip install gmvault 或 easy_install gmvault 命令。

2. 使用说明

认证方式

Gmvault 允许用户使用 XOAuth 令牌或 Gmail 登录密码进行认证。推荐使用 XOAuth 认证方式。

• 使用 XOAuth 认证时，首次为特定账户认证后，XOAuth 令牌将存储在 $HOME/.gmvault 目录下，用于后续的认证。
• 如果需要，也可以使用 --passwd 选项通过 Gmail 登录密码进行认证。

备份邮件

• 完整同步: 运行 $>gmvault sync [e-mail]。
• 增量同步: 运行 $>gmvault sync -t quick [e-mail]。

邮件默认备份在 $HOME/gmvault-db（Windows 下为 %HOME%/gmvault-db）目录下，您可以通过 -d DB_DIR 或 --db-dir DB_DIR 选项更改本地邮件存储位置。

恢复邮件

• 恢复到 Gmail 账户: 运行 $>gmvault restore [e-mail] 将 $HOME/gmvault-db（或 Windows 下的 %HOME%/gmvault-db）中的邮件恢复到 [e-mail]。
• 从指定位置恢复: 运行 $>gmvault restore [e-mail] -d /backup/emails-db 从 /backup/emails-db 路径恢复邮件。

使用 --resume 或 --restart 选项可以从中断处恢复操作，而无需重新上传已处理的邮件。

3. API 使用文档

本项目的 API 使用文档暂时无法提供，因为 Gmvault 是一个命令行工具，其主要功能通过 CLI（命令行界面）提供，并不直接暴露 API。但是，您可以查看项目的 GitHub 仓库，了解其内部结构和可能的接口定义。

4. 项目安装方式

• 二进制安装包: 从 Gmvault 官方网站 下载适合您操作系统的二进制安装包。
• 源代码安装: 克隆 GitHub 仓库，并在仓库目录中运行 python setup.py install 命令。
• PyPi 包安装: 使用 pip install gmvault 或 easy_install gmvault 命令通过 Python 包索引安装。

请确保按照以上步骤进行安装和使用，以便充分利用 Gmvault 提供的 Gmail 备份和恢复功能。