Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pimalaya/neverest
CLI to synchronize, backup and restore emails
https://github.com/pimalaya/neverest
backup cli email imap jmap maildir notmuch restore sync synchronizer
Last synced: 4 months ago
JSON representation
CLI to synchronize, backup and restore emails
- Host: GitHub
- URL: https://github.com/pimalaya/neverest
- Owner: pimalaya
- License: mit
- Created: 2024-03-25T13:05:39.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-08-26T09:54:32.000Z (4 months ago)
- Last Synced: 2024-08-26T12:05:33.390Z (4 months ago)
- Topics: backup, cli, email, imap, jmap, maildir, notmuch, restore, sync, synchronizer
- Language: Rust
- Homepage:
- Size: 176 KB
- Stars: 134
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
*The project is under active development, do not use in production before the final `v1.0.0` (or at least do some manual backups).*
## Features
- Backends configuration via interactive [wizard](https://pimalaya.org/neverest/cli/latest/configuration/index.html#automatically-using-the-wizard).
- Sync pairs of backend together ([IMAP](https://pimalaya.org/neverest/cli/latest/configuration/imap.html), [Maildir](https://pimalaya.org/neverest/cli/latest/configuration/maildir.html) and [Notmuch](https://pimalaya.org/neverest/cli/latest/configuration/notmuch.html) supported).
- Partial sync based on [filters](https://pimalaya.org/neverest/cli/latest/configuration/index.html#folderfilter) (folder name, envelope date).
- Restricted sync based on [permissions](https://pimalaya.org/neverest/cli/latest/configuration/index.html#leftrightfolderpermissions) (create/delete folder, update flag, create/update message).
- [Backup and restore](https://pimalaya.org/neverest/cli/latest/usage/backup-and-restore.html) emails using the [Maildir](https://pimalaya.org/neverest/cli/latest/configuration/maildir.html) backend.
*Coming soon:*
- *POP, JMAP and mbox support.*
- *Editing configuration via wizard.*
- *Native backup and restore support.*
## Installation
```bash
# Cargo
$ cargo install neverest
# Nix
$ nix-env -i neverest
```
*Please read the [documentation](https://pimalaya.org/neverest/cli/latest/installation.html) for other installation methods.*
## Configuration
Just run `neverest`, the wizard will help you to configure your default account. You can also manually edit your configuration at `~/.config/neverest/config.toml`:
config.sample.toml
```toml
[accounts.example]
# The current `example` account will be used by default.
default = true
# Filter folders according to the given rules.
#
# folder.filter.include = ["INBOX", "Sent"]
# folder.filter.exclude = ["All Mails"]
folder.filter = "all"
# Filter envelopes according to the given rules.
#
# envelope.filter.before = "1990-12-31T23:59:60Z"
# envelope.filter.after = "1990-12-31T23:59:60Z"
# The left backend configuration.
#
# In this example, the left side acts as our local cache.
left.backend.type = "maildir"
left.backend.root-dir = "/tmp/example"
# The left backend permissions.
#
# Example of a full permissive backend (default behaviour):
left.folder.permissions.create = true
left.folder.permissions.delete = true
left.flag.permissions.update = true
left.message.permissions.create = true
left.message.permissions.delete = true
# The right backend configuration.
#
# In this example, the right side acts as our remote.
right.backend.type = "imap"
right.backend.host = "localhost"
right.backend.port = 3143
right.backend.login = "alice@localhost"
# The right backend password.
#
# right.backend.passwd.cmd = "echo password"
# right.backend.passwd.keyring = "password-keyring-entry"
right.backend.passwd.raw = "password"
# The right backend encryption.
#
# right.backend.encryption = "tls" # or true
# right.backend.encryption = "start-tls"
right.backend.encryption = "none" # or false
# The right backend permissions.
#
# In this example, we set up safe permissions by denying deletions
# remote side.
right.folder.permissions.delete = false
right.message.permissions.delete = false
# The right folder aliases
#
# In this example, we define custom folder aliases for the right
# side. They are useful when you need to map left and right folders
# together.
right.folder.aliases.inbox = "Inbox"
right.folder.aliases.sent = "Sent Mails"
```
*Please read the [documentation](https://pimalaya.org/neverest/cli/latest/configuration/) for more detailed information.*
## Sponsoring
[](https://nlnet.nl/project/Pimalaya/index.html)
Special thanks to the [NLnet foundation](https://nlnet.nl/project/Pimalaya/index.html) and the [European Commission](https://www.ngi.eu/) that helped the project to receive financial support from:
- [NGI Assure](https://nlnet.nl/assure/) in 2022
- [NGI Zero Entrust](https://nlnet.nl/entrust/) in 2023
If you appreciate the project, feel free to donate using one of the following providers:
[](https://github.com/sponsors/soywod)
[](https://www.paypal.com/paypalme/soywod)
[](https://ko-fi.com/soywod)
[](https://www.buymeacoffee.com/soywod)
[](https://liberapay.com/soywod)
