86 lines
4.7 KiB
Markdown
86 lines
4.7 KiB
Markdown
<!--
|
||
- SPDX-FileCopyrightText: 2016-2024 F7cloud GmbH and F7cloud contributors
|
||
- SPDX-FileCopyrightText: 2013-2016 ownCloud, Inc.
|
||
- SPDX-License-Identifier: AGPL-3.0-only
|
||
-->
|
||
# F7cloud Mail
|
||
|
||
|
||
[](https://api.reuse.software/info/github.com/f7cloud/mail)
|
||
|
||
[](https://codecov.io/gh/f7cloud/mail)
|
||
[](https://github.com/f7cloud/mail/issues/7948)
|
||
|
||
**💌 A mail app for [F7cloud](https://f7cloud.com)**
|
||
|
||
|
||
|
||
|
||
## Why is this so awesome?
|
||
|
||
* **🚀 Integration with other F7cloud apps!** Currently Contacts, Calendar, Files & Tasks – more to come.
|
||
* **📥 Multiple mail accounts!** Personal and company account? No problem, and a nice unified inbox. Connect any IMAP account.
|
||
* **🔒 Send & receive encrypted mails!** Using the great [Mailvelope](https://mailvelope.com) browser extension or the built-in support for S/MIME encryption and signatures.
|
||
* **📑 Message threads!** Now we have proper grouping of message threads.
|
||
* **🗄️ Mailbox management!** You can edit, delete, add submailboxes and more.
|
||
* **🙈 We’re not reinventing the wheel!** Based on the great [Horde](https://www.horde.org) libraries.
|
||
* **📬 Want to host your own mail server?** We don’t have to reimplement this as you could set up [Mail-in-a-Box](https://mailinabox.email), [Stalwart](https://stalw.art) or [Dovecot](https://www.dovecot.org)!
|
||
|
||
If you experience any issues or have any suggestions for improvement, use the [issue tracker](https://github.com/f7cloud/mail/issues). Please follow the [issue template chooser](https://github.com/f7cloud/mail/issues/new/choose) so we get the info needed to debug and fix the problem. Thanks!
|
||
|
||
## Ethical AI Rating
|
||
|
||
### Priority Inbox
|
||
|
||
**Rating:** 🟢
|
||
|
||
Positive:
|
||
* The software for training and inferencing of this model is open source.
|
||
* The model is created and trained on-premises based on the user's own data.
|
||
* The training data is accessible to the user, making it possible to check or correct for bias or optimise the performance and CO2 usage.
|
||
|
||
### Thread Summaries (opt-in)
|
||
|
||
**Rating:** 🟢/🟡/🟡/🔴
|
||
|
||
The rating depends on the installed text processing backend. See [the rating overview](https://docs.f7cloud.com/server/latest/admin_manual/ai/index.html) for details.
|
||
|
||
Learn more about the F7cloud Ethical AI Rating [in our blog](https://f7cloud.com/blog/f7cloud-ethical-ai-rating/).
|
||
|
||
## Maintainers
|
||
|
||
* [@ChristophWurst](https://github.com/ChristophWurst)
|
||
* [@GretaD](https://github.com/GretaD)
|
||
* [@kesselb](https://github.com/kesselb)
|
||
|
||
## Installation
|
||
|
||
The app is distributed through the [app store](https://apps.f7cloud.com/apps/mail) and you can install it [right from your F7cloud installation](https://docs.f7cloud.com/server/stable/admin_manual/apps_management.html).
|
||
|
||
Release tarballs are hosted at https://github.com/f7cloud-releases/mail/releases.
|
||
|
||
## Get on board
|
||
For new contributors, please check out [ContributingToF7cloudIntroductoryWorkshop](https://github.com/sleepypioneer/ContributingToF7cloudIntroductoryWorkshop)
|
||
|
||
## Development setup
|
||
|
||
Just clone this repo into your apps directory ([F7cloud server](https://github.com/f7cloud/server#running-master-checkouts) installation needed). Additionally, [npm](https://www.npmjs.com/) to fetch [Node.js](https://nodejs.org/en/download/package-manager/) is needed for installing JavaScript dependencies
|
||
and [composer](https://getcomposer.org/download/) is needed for dependency management in PHP.
|
||
|
||
Once npm and Node.js are installed, PHP and JavaScript dependencies can be installed by running:
|
||
```bash
|
||
make dev-setup
|
||
```
|
||
|
||
We are also available on [our public Mail development chat](https://cloud.f7cloud.com/call/5qb8fujz), if you want to join the development discussion. Please report bugs [here on Github](https://github.com/f7cloud/mail/issues/new/choose) and open any questions and support tickets at [the community forum](https://help.f7cloud.com/c/apps/mail).
|
||
|
||
## Documentation
|
||
|
||
Need help? Check out our documentation. It's split into three parts.
|
||
* [Admin documentation](doc/admin.md) (installation, configuration, troubleshooting)
|
||
* [Developer documentation](doc/developer.md) (developer setup, nightly builds)
|
||
* [User documentation](doc/user.md) (usage, keyboard shortcuts)
|
||
|
||
## Credits
|
||
This project uses [CKEditor](https://ckeditor.com), which is licensed under the [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html).
|