Roundcube CardDAV 插件技术文档

1. 安装指南

环境要求

• 数据库：MySQL 或 PostgreSQL
• CURL：已安装并配置

安装步骤

1. 执行 SQL 语句：

   • 从 /plugins/carddav/SQL/yourDatabase.sql 文件中执行 SQL 语句，创建必要的表结构。

2. 配置插件：

   • 在 /config/main.inc.php 文件中，将 'carddav' 添加到 plugins 数组中。

3. 配置文件：

   • 将 /plugins/carddav/config.inc.php.dist 文件复制为 /plugins/carddav/config.inc.php，并根据需要进行配置。

4. 登录 Roundcube：

   • 登录到您的 Roundcube 网页邮箱，并在设置中添加您的 CardDAV 服务器。

2. 项目的使用说明

功能概述

• 多 CardDAV 服务器支持：每个用户可以添加多个 CardDAV 服务器。
• 本地数据库存储：CardDAV 联系人存储在本地数据库中，提供高性能。
• 支持的操作：可以读取、添加、删除和编辑 CardDAV 联系人（vCards）。
• 自动补全：在撰写电子邮件时，自动补全所有 CardDAV 联系人。
• 搜索功能：在地址簿中搜索所有 CardDAV 联系人。
• 自动同步：通过执行 /plugins/carddav/cronjob/synchronize.php 脚本，自动同步 CardDAV 联系人。

使用步骤

1. 添加 CardDAV 服务器：

   • 登录 Roundcube 后，进入设置页面，添加您的 CardDAV 服务器。

2. 管理联系人：

   • 在地址簿中，您可以查看、添加、编辑和删除 CardDAV 联系人。

3. 自动同步：

   • 将 /plugins/carddav/cronjob/synchronize.php 脚本添加到 crontab 中，以实现自动同步。

3. 项目 API 使用文档

API 概述

• 联系人管理：支持对 CardDAV 联系人的增删改查操作。
• 自动补全：在撰写邮件时，自动补全 CardDAV 联系人。
• 搜索功能：在地址簿中搜索 CardDAV 联系人。

API 示例

• 添加联系人：

  // 示例代码，具体实现请参考项目文档
  $contact = new CardDAVContact();
  $contact->add($data);
  

• 删除联系人：

  // 示例代码，具体实现请参考项目文档
  $contact = new CardDAVContact();
  $contact->delete($contact_id);
  

• 搜索联系人：

  // 示例代码，具体实现请参考项目文档
  $contacts = CardDAVContact::search($query);
  

4. 项目安装方式

安装步骤

1. 下载插件：

   • 从 GitHub 仓库下载最新版本的插件。

2. 解压并放置：

   • 将插件解压到 Roundcube 的 plugins 目录下。

3. 配置插件：

   • 按照安装指南中的步骤进行配置。

4. 执行 SQL 语句：

   • 执行 /plugins/carddav/SQL/yourDatabase.sql 文件中的 SQL 语句。

5. 登录并配置：

   • 登录 Roundcube，并在设置中添加您的 CardDAV 服务器。

通过以上步骤，您可以成功安装并使用 Roundcube CardDAV 插件。