Skip to content

Preserve your emails with this open-source self-hostable email archive! This repository is just a mirror, please go to the gitlab repo at https://gitlab.com/Dacid99/eonvelope to contribute code.

License

Notifications You must be signed in to change notification settings

Dacid99/Eonvelope

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

E∘nvelope

Docker Pulls Docker Image Version Read the Docs Translation status Coverage Pipeline Framework Code style

Preserve your emails for an indefinite long period of time with this open-source self-hostable email archive!

Features

As a user you may like this application because of

  • Automated continuous email fetching
  • Support for IMAP, POP and Exchange
  • Import and export of emails in various formats
  • Identification of related emails
  • Restoring of emails to your mailaccount
  • Cross integrations with other self-hosted projects like Paperless-ngx, Searxng and Grafana
  • Mobile-friendly Bootstrap5 webapp with PWA support
  • Easy filtering and searching options for your archived emails, attachments and correspondents

As an admin you may choose this project because of its

  • Quick and easy setup and configuration via container (docker, podman, kubernetes, etc.)
  • SSL certificate out of the box
  • Full-fledged API
  • Slim mode for low-spec systems

Check out the project website for screenshots and more information.

Your emails are serious business, so this projects codebase has > 95% test-coverage!

Roadmap

  • Consolidate existing features
  • A LOT of other ideas (see the TODO list)

Tell us what you'd like to see in a feature request!

If you encounter an issue please let us know via an issue or direct message!

Installation

The project is intended to be run with the container image provided at dockerhub.

Docker

Use docker compose using the compose file or an equivalent docker run command.

Podman

Do the same thing as above, just using podman instead of docker.

Kubernetes

You can use the example kubernetes cluster setup and launch it, for example via minikube.

Docs

The full documentation is available on ReadTheDocs.

Check it out for details on configuration and instructions on how to use the running server.

Translation

We are striving to support as many languages as possible to make the application accessible to everyone!

Translation is done via weblate. If you want to add a language that is missing, go check it out! If the language is missing on weblate too, please file an issue using the missing-language template.

Accessibility

Everybody should be able to use Eonvelope. Please don't hesitate to report any problem related to accessibility via an issue.

Contributing

If you want to help with improving this project that is great! Please don't hesitate to approach us with ideas. And of course we are looking forward to your pull requests!

To get you started smoothly just follow the development guide. This will help you set up a workspace for working with this project conveniently!

In order to keep the code maintainable and in a consistent style please make sure to follow the rules in the guidelines.

The complete source code documentation is part of the docs on ReadTheDocs

Thank you to everybody who helped with advancing this project and who helped with translation!

License

This software is proudly released under the GNU Affero General Public License v3.0 or later (AGPLv3) open-source license.

Its documentation is licensed under the Creative Commons Attributions-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Any contributions will be subject to the same licensing.

About

Preserve your emails with this open-source self-hostable email archive! This repository is just a mirror, please go to the gitlab repo at https://gitlab.com/Dacid99/eonvelope to contribute code.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks