Thunderbird for Android 开源项目全解析:从 K-9 Mail 继承到多应用模块化架构
Thunderbird for Android 开源项目全解析:从 K-9 Mail 继承到多应用模块化架构
Thunderbird for Android 是 Mozilla 旗下的开源 Android 邮件客户端,本仓库是其完整源码,同时产出 Thunderbird 与 K-9 Mail 两个应用。本文以仓库根目录 README.md 为骨架,结合 settings.gradle.kts、SECURITY.md、docs/engineering 与 docs/architecture 等仓库资源,系统讲解项目的定位、下载渠道、社区协作方式、工程流程、K-9 Mail 渊源,以及最关键的"Fork 改造 OAuth 客户端"实战细节,读完即可掌握该仓库的模块布局与二次开发入口。
项目定位:基于 K-9 Mail 的隐私优先邮件应用
README 开门见山地给出项目定位:Thunderbird for Android 是一款强大、隐私优先的邮件应用,支持在一个应用中管理多个邮箱账户,并提供统一收件箱(Unified Inbox)以提升生产力。它的技术底座是有着丰富开源邮件历史的 K-9 Mail(README 原话:"Thunderbird for Android is based on K-9 Mail, which comes with a rich history of success and functionality in open source email")。
关键的产品原则在 README 中表述为:"Thunderbird never treats your private data as a product"(Thunderbird 从不把你的私人数据当作商品)。这一隐私承诺落实在代码层面,体现为仓库中对网络安全的重视:所有网络连接强制使用 TLS 并做证书校验,敏感凭据不落明文(见 docs/architecture/README.md 的安全章节),以及独立成模块的 OpenPGP 加密支持(plugins/openpgp-api-lib)。
从构建配置看,这是一个单仓库多产物工程:settings.gradle.kts 中同时 include 了 :app-thunderbird 与 :app-k9mail 两个应用模块,共享 :app-common 公共代码;根项目名为 tfa,启用了 TYPESAFE_PROJECT_ACCESSORS 特性预览,并要求 Java 21+ 环境(构建时会对 JavaVersion.VERSION_21 做兼容性检查,否则直接报错提示安装 JDK 21)。
获取应用:下载渠道与版本矩阵
README 列出了 Thunderbird for Android 的全部官方获取渠道,按版本区分:
- 正式版(Thunderbird):Google Play、F-Droid 均有发布。
- Beta 版(Thunderbird Beta):同样覆盖 Google Play 与 F-Droid,包名不同(对应元数据目录 app-metadata/net.thunderbird.android.beta)。使用 Beta 版可以提前体验当前开发中的新特性。
- GitHub Releases:直接从发布页获取构建产物。
- FFUpdater:一个 F-Droid 上的应用,可安装来自 ftp.mozilla.org 的最新版本。
- Obtainium:可在 "Additional options" 下的 "Filter release title by regular expression" 中填入
Thunderbird过滤出对应版本。
上述渠道在仓库中都能找到对应证据:
- 商店元数据按包名与应用分目录维护,如 app-metadata/net.thunderbird.android、app-metadata/net.thunderbird.android.beta 与 app-metadata/com.fsck.k9,内含
title.txt、short_description.txt、full_description.txt及多语言changelogs/。 - 各渠道的依赖与 badging 信息沉淀在 app-thunderbird/badging(foss/full × Beta/Daily/Release 六个变体)与 app-thunderbird/dependencies 中。
README 还特别提醒:签名证书的 SHA-256 指纹记录在 SECURITY.md。安装 APK 前可用以下命令核验证书:
apksigner verify -v --print-certs <path-to-apk>
三个产物的指纹在 SECURITY.md 中均有记录,其中 Thunderbird 正式版指纹为 B6:52:47:79:B3:DB:BC:5A:C1:7A:5A:C2:71:DD:B2:9D:CF:BF:72:35:78:C2:38:E0:3C:3C:21:78:11:35:6D:D1,Beta 版与 K-9 Mail 指纹各不相同——这也是下面"Fork 时必须更换 OAuth 客户端"的直接原因之一。
安全背书:CASA 评估与第三方审计
仓库的 SECURITY.md 提供了两个安全事实,可直接作为项目可信度的依据:
- CASA 评估(Tier 2):Google 要求申请 Gmail 受限 scope 的应用每年接受 Cloud Application Security Assessment 审查。Thunderbird for Android 与 K-9 Mail 已由 ADA 认可的评估机构 NetSentries 完成 Tier 2 评估,覆盖更广泛的 Gmail 功能访问。
- OSTIF / 7ASecurity 安全审计(2023 上半年):该代码库与开源技术改进基金(OSTIF)及 7ASecurity 合作完成了一次全面安全审计。
这两项都是 README 之外、同样位于仓库内的官方事实(SECURITY.md),读者可将它们作为评估项目安全性的参考。
遇到问题与参与讨论:官方支持渠道
README 明确区分了不同诉求对应的沟通路径:
- 应用行为异常、疑似 bug:先查知识库与 FAQ;确定是 bug 后,到官方 issue 跟踪器提交 issue。
- 功能建议:不在 GitHub Issues 直接提新想法,而是通过 Mozilla Connect 的 Ideas 专区提交并投票;被接受并排期后,维护者才会创建对应 GitHub issue(这一点在 docs/CONTRIBUTING.md 中有更细的说明:
unconfirmed标签的 bug 暂不接受贡献,tb-team标签为维护者保留)。 - 实时交流:Thunderbird 社区使用 Matrix,分为普通讨论频道(#tb-android:mozilla.org)、开发频道(#tb-android-dev:mozilla.org)与更广的社区空间。
Roadmap 与工程流程:RFC → Technical Design → ADR
Roadmap 追踪
README 指向项目 Roadmap(GitHub Projects)与核心团队的 sprint board。仓库内部,工程流程的完整说明位于 docs/engineering/README.md,其核心是"三支柱"模型:
- Roadmap(路线图):用 Notion Epic 与 Notion Milestone 承载高层目标,是维护者资源规划的主导输入。
- Public Delivery(公开交付):用 GitHub Milestone Issue、GitHub Feature Issue、GitHub Task Issue 跟踪"交付什么、何时交付",是交付工作的真相来源,也是外部贡献者可见的层面。
- Proposals & Decisions(提案与决策):以 RFC、ADR、Technical Design、User Journey 等仓库内文档沉淀"为什么做、怎么做",形成可长期检索的技术记录。
贡献者视角的工程流程
README 提到的三类文档在 docs/engineering 目录中均有实体:
- docs/engineering/rfcs/README.md:RFC,用于在实现前对齐技术方向,尤其适合存在多种合理方案、影响面广或范围不清晰的情形。
- docs/engineering/technical-designs/README.md:Technical Design,描述已接受方向的实现细节(schema、API 契约、迁移方案、构建工具链等)。
- docs/engineering/adr/README.md:ADR,记录持久性的架构决策(决策是什么、为什么、后果是什么)。
按 docs/engineering/README.md 的"常见场景"指引选择路径:
| 场景 | 需要的制品 | 流程 |
|---|---|---|
| 小修复/小改进 | (可选)Task Issue + PR | 直接写代码,需要跟踪再建 issue |
| 标准功能/有限变更 | Milestone Issue + Feature/Task Issues + PR | 先定义交付结果,再拆解实现 |
| 复杂功能/重大变更 | Milestone Issue + Technical Design + Issues + PRs | 先定目标,再用 Task Issue 产出一份 Technical Design |
| 新技术方向/大影响 | RFC(+ Technical Design)+ Milestone Issue + Issues + PRs | 先用 RFC 达成共识 |
| 根本性架构决策 | ADR(+ RFC)+ PR | 直接记录决策与后果 |
| 路线图驱动工作 | Notion Epic + Milestone Issue + Issues + PRs | 从高层目标对齐到公开交付 |
外部贡献者的标准起点是:从已有的 GitHub Bug/Feature/Task Issue 出发,先阅读 docs/CONTRIBUTING.md 与 docs/contributing/contribution-workflow.md(含分支、提交、PR 全流程),再参考 docs/contributing/development-environment.md 搭建 Android Studio 开发环境。
源码布局:面向双应用与未来 Kotlin Multiplatform 的模块化架构
虽然 README 本身不展开架构,但仓库根目录的 settings.gradle.kts 与 docs/architecture/README.md 完整印证了它的技术骨架。整个工程按以下模块类型组织:
- 应用模块:
:app-thunderbird、:app-k9mail,是两个应用的入口;各自还有debug/daily/beta/release等构建变体源码目录(如 app-thunderbird/src)。 - 公共应用模块:
:app-common,两个应用共享的代码。 - 功能模块:
feature:*,如:feature:account:setup(账户设置)、:feature:mail:message:composer(写信)、:feature:notification:api/impl(通知)、:feature:widget:*(桌面小部件)等,每个模块再细分api与internal子模块。 - 核心模块:
core:*,如:core:common、:core:featureflag(功能开关)、:core:logging:*(日志体系)、:core:configstore:*(配置存储)等,被多个功能模块复用。 - 邮件协议与后端:
:mail:protocols:imap|pop3|smtp(协议实现)与:backend:imap|pop3|jmap(新架构下的后端抽象,jmap模块的存在说明工程正面向 JMAP 协议演进)。 - 遗留模块:
legacy:*,即从 K-9 Mail 继承的旧代码,正在逐步迁移到新架构。 - 库模块:
:library:html-cleaner、:library:pii-safe(PII 安全注解与编译器插件)等。 - CLI 工具:
:cli:autodiscovery-cli、:cli:weblate-cli等,服务于自动发现、翻译同步等工程化任务。
架构文档(docs/architecture/README.md)进一步说明其设计原则:面向未来 Kotlin Multiplatform 的兼容性设计、离线优先(Offline-First,本地数据库为单一真相来源、后台同步、操作队列、冲突解决)、Clean Architecture 三层(UI/Domain/Data)与 API/Internal 分离、依赖倒置,UI 采用 Jetpack Compose + 改进版 MVI 模式,依赖注入使用 Koin,错误处理偏好 Outcome 模式与密封类而非异常。
K-9 Mail 渊源:同代码、双应用
README 用一个专章说明 K-9 Mail 与本项目的关系:2022 年 6 月,K-9 Mail 加入 Thunderbird 家族,成为 Thunderbird for Android 的基础。此后两个应用持续同步更新,因此它们"看起来几乎一样"是刻意为之——它们基于同一套代码,只有部分功能会针对 Thunderbird 选择性启用(例如"从 K-9 导入"这类更适合 Thunderbird 的功能)。
仓库布局为这一事实提供了直接证据:
- 两个应用共享
:app-common模块(app-common),并在settings.gradle.kts中由同一工程构建。 - 共享功能模块通过
feature:thundermail区分差异::feature:thundermail:api提供公共 API,:feature:thundermail:thunderbird与:feature:thundermail:k9mail分别是两个应用的适配实现。 - 主题系统同样双轨:
:core:ui:legacy:theme2:k9mail与:core:ui:legacy:theme2:thunderbird。 - 若仍想继续使用 K-9 Mail("robot dog"),README 给出了其 Google Play、F-Droid、Obtainium 的获取方式。
Fork 实战:必须替换 OAuth 客户端配置
README 的 Forking 章节是本仓库中最重要的二次开发实战指引,原文指出:如果要用本项目的 fork,必须把 OAuth 客户端配置替换为你自己的 OAuth 客户端,涉及两个文件:
app-k9mail/src/{debug,release}/kotlin/app/k9mail/auth/K9OAuthConfigurationFactory.kt
app-thunderbird/src/{debug,daily,beta,release}/kotlin/net/thunderbird/android/auth/TbOAuthConfigurationFactory.kt
原因在 README 中表述得很清楚:防止与主应用在同一台设备上共存时产生冲突。若 fork 版沿用官方 OAuth 客户端凭据,两个应用使用相同的 redirectUri 完成 OAuth 回调,系统级意图解析与令牌归属都会出现歧义。
仓库中这两类文件确实存在,且覆盖了全部构建变体:
- K-9 侧:
app-k9mail/src/debug/kotlin/app/k9mail/auth/K9OAuthConfigurationFactory.kt与app-k9mail/src/release/kotlin/app/k9mail/auth/K9OAuthConfigurationFactory.kt。 - Thunderbird 侧:
app-thunderbird/src/beta|daily|debug|release/kotlin/net/thunderbird/android/auth/TbOAuthConfigurationFactory.kt四个变体。
Fork 时的操作清单如下:
- 注册自己的 OAuth 客户端:在目标邮件服务商(如 Google、Microsoft 等)的开发者控制台创建 OAuth 2.0 客户端,拿到自己的 client id/secret。
- 替换配置工厂:在上述两个 Factory 文件中填入自己的客户端凭据。
- 更换
redirectUri:确保与主项目使用的 redirect URI 不同,避免与官方应用在设备上互相干扰。 - 按变体分别处理:注意
debug、beta、daily、release各变体是独立文件,fork 时每个构建变体都要替换,否则调试包与发布包会使用不同凭据导致行为不一致。
OAuth 相关能力在功能模块中亦有完整实现可参考,例如 feature/account/oauth(feature/account/oauth)模块承载 OAuth 授权流程,feature:account:server:settings 处理账户服务器配置;配合 docs/architecture/README.md 的安全章节可知,OAuth 令牌会通过安全凭据存储而非明文保存。
参与贡献与翻译
README 明确欢迎所有人贡献,并给出几条路径:
- 开发:懂一点 Kotlin 即可,从 docs/CONTRIBUTING.md 的指引开始(内含贡献工作流、开发环境搭建、工程流程、架构文档、开发/质量/测试指南的完整索引)。
- 翻译:通过 Weblate 平台进行,几分钟即可完成首次翻译;仓库内 docs/contributing/translations.md 与 docs/contributing/managing-strings.md 分别说明翻译参与方式与字符串管理规范。
- 财务支持:Thunderbird 完全依靠用户捐赠维持运营,README 提供了捐赠入口。
需要留意的是,所有贡献者都应遵守 Mozilla Community Participation Guidelines(社区参与准则),仓库内也有 CODE_OF_CONDUCT.md。
许可证与安全报告
- 许可证:Thunderbird for Android 采用 Apache License, Version 2.0。
- 安全漏洞报告:通过 SECURITY.md 提供的漏洞报告表单提交,官方鼓励社区帮助项目保持安全。
总结
Thunderbird for Android 不是一次从零开始的"新邮件应用",而是 K-9 Mail 二十余年开源积累之上、面向未来 Kotlin Multiplatform 与离线优先架构的现代化重写。本文梳理的下载渠道、工程流程(RFC/ADR/Technical Design)、双应用模块布局、OAuth fork 改造要点,均以仓库根 README.md 为主线、以 settings.gradle.kts、SECURITY.md、docs/engineering 与 docs/architecture 为佐证。对于想要二次开发或 fork 的开发者,最短路径是:阅读 docs/CONTRIBUTING.md 了解协作规范 → 按 docs/contributing/development-environment.md 搭建环境 → 参考本仓库模块布局定位代码 → 按上文清单替换 OAuth 配置后构建自己的发行版。