mirror of https://github.com/soywod/himalaya.git synced 2024-07-03 07:55:13 +00:00

CLI to manage emails

cli email email-client gpg himalaya idle imap mail mail-client mutt notmuch pgp rust rust-imap smtp

Go to file

Clément DOUIN 3f2f691e85 add missing v1 changes to changelog		2023-12-20 11:13:24 +01:00
.github	fix releases	2023-07-18 17:23:24 +02:00
.vscode	add nix support (#76 )	2021-04-18 00:06:11 +02:00
assets	release v0.5.2 (#282 )	2022-02-02 02:21:35 +01:00
src	remove obsolete unit tests	2023-12-20 08:17:06 +01:00
.gitignore	update code for sendmail sender lib feature	2022-10-12 13:59:20 +02:00
Cargo.lock	bump all deps	2023-12-19 15:38:24 +01:00
Cargo.toml	bump all deps	2023-12-19 15:38:24 +01:00
CHANGELOG.md	add missing v1 changes to changelog	2023-12-20 11:13:24 +01:00
config.sample.toml	bump all deps	2023-12-19 15:38:24 +01:00
CONTRIBUTING.md	prepare v0.7.1	2023-02-14 16:47:02 +01:00
default.nix	refactor msg model (#173 )	2021-09-11 00:35:22 +02:00
flake.lock	update pimalaya libs, prepare v0.9.0	2023-08-28 09:05:14 +02:00
flake.nix	update pimalaya libs, prepare v0.9.0	2023-08-28 09:05:14 +02:00
install.sh	fix install.sh bin name	2021-05-08 22:52:43 +02:00
LICENSE	fix imap credentials and pgp	2023-12-03 13:03:36 +01:00
README.md	add readme warning about docs mismatch	2023-12-20 09:11:06 +01:00
rust-toolchain.nix	update pimalaya libs, prepare v0.9.0	2023-08-28 09:05:14 +02:00
rust-toolchain.toml	move id mapper from lib to CLI	2023-05-14 21:41:31 +02:00
shell.nix	refactor msg model (#173 )	2021-09-11 00:35:22 +02:00

README.md

📫 Himalaya

https://pimalaya.org/himalaya/cli/latest/

CLI to manage emails, based on email-lib.

⚠️ The v1.0.0-beta is available on master, which introduces breaking changes (see CHANGELOG). The documentation differs too much from the latest release v0.9.0. Knowing that pimalaya.org only points to master (till the final v1.0.0), it is highly recommended to migrate to the beta. You can install it using cargo or from sources.

Disclaimer: the project is under active development, do not use in production before the v1.0.0.

Features

Mailbox management
Envelopes listing
Message composition based on $EDITOR
Message manipulation (copy/move/delete)
Multi-accounting
Account synchronization for offline usage
Support for IMAP, Maildir, notmuch
Sending via SMTP or sendmail
PGP end-to-end encryption
Generate completion scripts for various shells
Generate man pages
JSON output
…and more!

Installation

# Arch Linux (official)
$ pacman -S himalaya

# Arch Linux (from sources)
$ yay -S himalaya-git

# Homebrew
$ brew install himalaya

# Scoop
$ scoop install himalaya

# Cargo
$ cargo install himalaya

# Nix
$ nix-env -i himalaya

# Fedora/CentOS
$ dnf copr enable atim/himalaya
$ dnf install himalaya

See the documentation for other installation methods.

Configuration

Please read the documentation.

Contributing

If you want to report a bug that does not exist yet, please send an email at ~soywod/pimalaya@todo.sr.ht.

If you want to propose a feature or fix a bug, please send a patch at ~soywod/pimalaya@lists.sr.ht using git send-email. Follow this guide to configure git properly.

If you just want to discuss about the project, feel free to join the Matrix workspace #pimalaya.general or contact me directly @soywod. You can also use the mailing list [send an email|subscribe|unsubscribe].

Sponsoring

Special thanks to the NLnet foundation and the European Commission that helped the project to receive financial support from:

NGI Assure in 2022
NGI Zero Untrust in 2023

If you appreciate the project, feel free to donate using one of the following providers: