mirror of https://github.com/soywod/himalaya.git synced 2024-11-24 20:10:23 +00:00

CLI to manage emails

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

Find a file

Clément DOUIN f9b92e6e7a Merge branch 'thread' Replaced `imap` crate by `imap-{types,codec,flow,client}`, and added thread support for IMAP and Maildir.		2024-05-29 10:55:54 +02:00
.github	fix release gh action	2024-04-20 07:50:57 +02:00
.vscode	add nix support (#76 )	2021-04-18 00:06:11 +02:00
assets	add himalaya-watch@.service	2024-03-09 13:49:44 +01:00
src	Merge branch 'thread'	2024-05-29 10:55:54 +02:00
.gitignore	update code for sendmail sender lib feature	2022-10-12 13:59:20 +02:00
Cargo.lock	bump imap libs	2024-05-29 10:55:21 +02:00
Cargo.toml	Merge branch 'thread'	2024-05-29 10:55:54 +02:00
CHANGELOG.md	release v1.0.0-beta.4	2024-04-16 22:26:10 +02:00
config.sample.toml	fix cargo features issues	2024-02-24 14:27:05 +01:00
CONTRIBUTING.md	fix(CONTRIBUTING): Patches are requested to the wrong email	2024-03-09 11:08:29 +01:00
default.nix	refactor msg model (#173 )	2021-09-11 00:35:22 +02:00
flake.lock	release v1.0.0-beta.4	2024-04-16 22:26:10 +02:00
flake.nix	clean remaining parts	2024-04-19 22:11:16 +02:00
install.sh	fix install.sh aarch64	2024-04-20 09:07:45 +02:00
LICENSE	update license year	2024-01-01 00:31:19 +01:00
README.md	fix typos in changelog and readme	2024-03-10 11:06:50 +01:00
rust-toolchain.nix	add nix test github workflow	2024-04-18 22:06:24 +02:00
rust-toolchain.toml	release v1.0.0-beta.4	2024-04-16 22:26:10 +02:00
shell.nix	refactor msg model (#173 )	2021-09-11 00:35:22 +02:00

README.md

📫 Himalaya

Welcome to Himalaya CLI, the Command-Line Interface to manage emails based on email-lib.

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

Features

Folder (aka mailbox) management
Envelope listing, filtering and sorting
Message composition based on $EDITOR
Message manipulation (copy/move/delete)
Multi-accounting
Account synchronization for offline usage
Support multiple backends: IMAP, Maildir, Notmuch, SMTP, Sendmail.
PGP end-to-end encryption
Generate man pages
Generate completion scripts for various shells
JSON output
…and more! Get started now

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

Please read the contributing guide for more detailed information.

A bug tracker is available on SourceHut. ^{[send an email]}

A mailing list is available on SourceHut. ^{[send an email] [subscribe] [unsubscribe]}

If you want to report a bug, 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. The simplest way to send a patch is to use 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.himalaya or contact me directly @soywod. You can also use the mailing list.

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 Entrust in 2023

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