IMAPdedup 技术文档

本文档将详细介绍如何安装、使用以及通过API操作 IMAPdedup 项目。IMAPdedup 是一个 Python 脚本，用于查找 IMAP 邮箱中的重复邮件，并标记除第一份副本外的所有重复邮件为已删除。

1. 安装指南

IMAPdedup 目前没有特定的安装过程。您只需要获取 imapdedup.py 文件和 Python 3。

2. 项目的使用说明

尝试使用

在尝试使用之前，您可以在邮件服务器上创建一个新文件夹，并将一些邮件从中复制到您的收件箱中。然后再次复制其中的一些邮件。这将为您提供一个安全的环境进行测试。

简单使用

请注意：IMAPdedup 需要 Python 3 环境。

您可以通过以下命令查看完整的语法：

./imapdedup.py -h

或者，如果您的系统不能直接执行 Python 脚本，您可能需要：

python3 imapdedup.py -h

尝试使用以下命令进行无风险的测试：

./imapdedup.py -s imap.myisp.com -u myuserid -x -l

该命令将提示您输入密码，并列出服务器上的邮箱。然后，您可以使用它返回的邮箱名称来运行其他命令。

命令行选项

• -s：指定 IMAP 服务器地址。
• -u：指定用户名。
• -x：使用 SSL 连接。
• -l：列出邮箱。
• -n：模拟运行，不做实际修改。
• -v：显示详细信息。
• -y：在删除之前将邮件复制到指定邮箱。
• -t：使用自定义标签而非删除。
• -r：递归搜索子文件夹。
• -R：逆序处理文件夹。
• -K：从系统密钥环获取密码。

密码指定

您可以通过以下方式之一指定密码：

• 通过环境变量 IMAPDEDUP_PASSWORD。
• 在包装脚本中指定。
• 使用系统密钥环（需要安装 keyring）。

身份验证为管理员用户

某些 IMAP 服务器允许管理员用户登录后代表其他用户执行操作。如果您的服务器支持通过 'AUTHENTICATE PLAIN' 命令的方式，可以使用 -a 选项指定管理员用户名。

3. 项目 API 使用文档

IMAPdedup 可以从外部脚本调用。您需要构造一个包含命令行参数的列表，然后使用以下方式处理：

import imapdedup

options = [
    "-s", "imap.example.com",
    "-u", "my_user_name",
    "-w", "my_password",
    "-x"
]

mboxes = [
    'INBOX',
    'Some other mailbox',
]

imapdedup.process(*imapdedup.get_arguments(options + mboxes))

确保处理好敏感信息，例如密码，不要在共享文件系统中明文存储。

4. 项目安装方式

如前所述，IMAPdedup 的安装仅需要下载 imapdedup.py 文件和安装 Python 3。确保您有运行 Python 脚本所需的权限。