2015-06-28 05:27:06 +00:00
|
|
|
# K-9 Mail
|
2023-02-03 16:28:34 +00:00
|
|
|
|
2023-11-02 11:18:12 +00:00
|
|
|
[](https://github.com/thunderbird/thunderbird-android/releases/latest)
|
|
|
|
|
[](https://github.com/thunderbird/thunderbird-android/releases)
|
2015-06-19 13:02:56 +00:00
|
|
|
|
2015-06-28 05:27:06 +00:00
|
|
|
K-9 Mail is an open-source email client for Android.
|
2015-06-19 13:02:56 +00:00
|
|
|
|
2015-06-28 05:27:06 +00:00
|
|
|
## Download
|
2015-06-19 13:02:56 +00:00
|
|
|
|
2015-06-28 05:27:06 +00:00
|
|
|
K-9 Mail can be downloaded from a couple of sources:
|
2015-06-19 13:02:56 +00:00
|
|
|
|
2015-06-28 05:27:06 +00:00
|
|
|
- [Google Play](https://play.google.com/store/apps/details?id=com.fsck.k9)
|
|
|
|
|
- [F-Droid](https://f-droid.org/repository/browse/?fdid=com.fsck.k9)
|
2023-11-02 11:18:12 +00:00
|
|
|
- [Github Releases](https://github.com/thunderbird/thunderbird-android/releases)
|
2015-06-19 13:02:56 +00:00
|
|
|
|
2020-09-06 18:28:48 +00:00
|
|
|
You might also be interested in becoming a [tester](https://forum.k9mail.app/t/how-do-i-become-a-beta-tester/68) to get an early look at new versions.
|
2015-06-19 13:02:56 +00:00
|
|
|
|
2015-06-28 05:27:06 +00:00
|
|
|
## Release Notes
|
|
|
|
|
|
2023-11-02 11:18:12 +00:00
|
|
|
Check out the [Release Notes](https://github.com/thunderbird/thunderbird-android/wiki/ReleaseNotes) to find out what changed
|
2015-06-28 05:27:06 +00:00
|
|
|
in each version of K-9 Mail.
|
|
|
|
|
|
|
|
|
|
## Need Help?
|
|
|
|
|
|
|
|
|
|
If the app is not behaving like it should, you might find these resources helpful:
|
|
|
|
|
|
2022-04-25 15:40:19 +00:00
|
|
|
- [User Manual](https://docs.k9mail.app/)
|
2020-09-06 18:28:48 +00:00
|
|
|
- [Frequently Asked Questions](https://forum.k9mail.app/c/faq)
|
2020-05-17 23:47:14 +00:00
|
|
|
- [Support Forum](https://forum.k9mail.app/)
|
2015-06-28 05:27:06 +00:00
|
|
|
|
|
|
|
|
## Translations
|
|
|
|
|
|
|
|
|
|
Interested in helping to translate K-9 Mail? Contribute here:
|
|
|
|
|
|
2023-10-21 11:53:47 +00:00
|
|
|
- [K-9 Mail localization](https://hosted.weblate.org/projects/tb-android/)
|
2015-06-28 05:27:06 +00:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2023-02-03 16:28:34 +00:00
|
|
|
Thank you for contributing! If you're unfamiliar with the code, start by reading the [developer documentation](docs/DESIGN.md)
|
2019-01-11 10:26:44 +00:00
|
|
|
|
2023-11-02 11:18:12 +00:00
|
|
|
Please fork this repository and contribute back using [pull requests](https://github.com/thunderbird/thunderbird-android/pulls).
|
2015-06-28 05:27:06 +00:00
|
|
|
|
|
|
|
|
Any contributions, large or small, major features, bug fixes, unit/integration tests are welcomed and appreciated
|
|
|
|
|
but will be thoroughly reviewed and discussed.
|
2023-11-02 11:18:12 +00:00
|
|
|
Please make sure you read the [Code Style Guidelines](https://github.com/thunderbird/thunderbird-android/wiki/CodeStyle).
|
2015-06-28 05:27:06 +00:00
|
|
|
|
2023-10-05 15:08:50 +00:00
|
|
|
### Architecture Decision Records (ADR)
|
|
|
|
|
|
|
|
|
|
We use [Architecture Decision Records](https://adr.github.io/) to document the architectural decisions made in the
|
|
|
|
|
development of K-9 Mail. You can find them in the [`docs/architecture/adr`](docs/architecture/adr) directory.
|
|
|
|
|
|
|
|
|
|
For more information about our ADRs, please see the [ADRs README](docs/architecture/adr/README.md).
|
|
|
|
|
|
|
|
|
|
We encourage team members and contributors to read through our ADRs to understand the architectural decisions that
|
|
|
|
|
have shaped this project so far. Feel free to propose new ADRs or suggest modifications to existing ones as needed.
|
|
|
|
|
|
2015-06-28 05:27:06 +00:00
|
|
|
## Communication
|
|
|
|
|
|
2023-11-02 11:18:12 +00:00
|
|
|
Aside from discussing changes in [pull requests](https://github.com/thunderbird/thunderbird-android/pulls) and
|
|
|
|
|
[issues](https://github.com/thunderbird/thunderbird-android/issues) we use the following communication services:
|
2015-06-28 05:27:06 +00:00
|
|
|
|
2024-01-12 18:35:52 +00:00
|
|
|
- Matrix: [#tb-android:mozilla.org](https://matrix.to/#/#tb-android:mozilla.org)
|
2015-06-28 05:27:06 +00:00
|
|
|
|
2024-01-15 14:33:06 +00:00
|
|
|
## Security
|
|
|
|
|
|
|
|
|
|
The code in this repository was undergoing an extensive security audit in collaboration with the Open Source Technology
|
|
|
|
|
Improvement Fund ([OSTIF](https://ostif.org/)) and [7ASecurity](https://7asecurity.com/) in the first half of 2023. For
|
|
|
|
|
more details, see
|
|
|
|
|
our [blog post](https://blog.thunderbird.net/2023/07/k-9-mail-collaborates-with-ostif-and-7asecurity-security-audit/).
|
|
|
|
|
|
2015-06-28 05:27:06 +00:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
