docker-imap-backup

概述

docker-imap-backup 是 imap-backup 的 Docker 化版本。imap-backup 工具可将 IMAP 邮件同步为 .mbox 格式的备份文件，与 isync（同步为 Maildir 格式，即单封邮件单个文件）形成对比。

可用标签

以下是镜像的可用标签及对应的 Dockerfile 构建上下文（点击标签可查看详情）：

使用说明

示例参考

可参考以下 docker-compose 示例：

• 基于 crond 的定时备份
• 演示备份

基础命令

以下是常用操作命令（替换 16.2.0 为实际需要的标签）：

1. 查看命令用法

sh
docker run --rm -it theohbrothers/docker-imap-backup:16.2.0 help  

2. 交互式配置（推荐初次使用）

通过交互方式添加***账户并保存配置：

sh
docker run --rm -it -v imap-backup:/root/.imap-backup theohbrothers/docker-imap-backup:16.2.0 setup  

配置步骤：

• 选择 1. 添加账户，依次输入：
  • ***地址
  • 密码
  • IMAP 服务器地址
  • 连接选项（如使用自签名证书，输入 JSON：{"ssl": {"verify_mode": 0}}）
  • 测试连接（确认配置正确）
• 按 q 返回主菜单，选择 3. 保存并退出

3. 查看配置文件

确认配置是否正确：

sh
docker run --rm -it -v imap-backup:/root/.imap-backup theohbrothers/docker-imap-backup:16.2.0 cat /root/.imap-backup/config.json  

4. 执行备份

按配置同步邮件到本地 .mbox 文件：

sh
docker run --rm -it -v imap-backup:/root/.imap-backup theohbrothers/docker-imap-backup:16.2.0 backup  

5. 检查备份完整性（仅 9.2.0 以上版本支持）

验证备份文件是否完整：

sh
docker run --rm -it -v imap-backup:/root/.imap-backup theohbrothers/docker-imap-backup:16.2.0 local check  

6. 查看备份统计

显示指定的备份统计信息（替换 <email> 为实际）：

sh
docker run --rm -it -v imap-backup:/root/.imap-backup theohbrothers/docker-imap-backup:16.2.0 stats <email>  

7. 列出备份文件

查看本地备份文件结构：

sh
docker run --rm -it -v imap-backup:/root/.imap-backup theohbrothers/docker-imap-backup:16.2.0 ls -alR /root/.imap-backup  

8. 恢复邮件（替换为支持恢复的版本，如 9.3.1）

将本地备份恢复到 IMAP 服务器（替换 <email> 为实际***）：

sh
docker run --rm -it -v imap-backup:/root/.imap-backup theohbrothers/docker-imap-backup:9.3.1 restore <email>  

9. 启动容器内 shell

进入容器内部调试或执行自定义命令：

sh
docker run --rm -it -v imap-backup:/root/.imap-backup theohbrothers/docker-imap-backup:16.2.0 sh  

开发说明

环境要求

需安装 Windows powershell 或 pwsh（跨平台 PowerShell）。

生成镜像变体

1. 安装模块：

powershell
Install-Module -Name Generate-DockerImageVariants -Repository PSGallery -Scope CurrentUser -Force -Verbose  

2. 编辑 ./generate 目录下的模板文件。

3. 生成变体：

powershell
Generate-DockerImageVariants .  

更新版本

版本列表维护在 versions.json（每行一个 Semver 版本）。

仅更新版本列表

powershell
./Update-Versions.ps1  

自动更新并提交

更新版本列表、为每个变更版本创建 PR、自动合并（避免冲突）、创建标签发布并关闭里程碑：

powershell
$env:GITHUB_TOKEN = '你的 GitHub Token'  
./Update-Versions.ps1 -PR -AutoMergeQueue -AutoRelease  

注：添加 -WhatIf 参数可执行 dry run（仅预览操作，不实际执行）。