mirror of
https://github.com/soywod/himalaya.git
synced 2025-04-22 01:03:26 +00:00
509b09d533
Those commits have been stashed then applied due to merge issue: add ability to sync specific folders f7585eb add expunge command 1c0b7fb update readme links to documentation e1c8cf5 fix other doc typos 9c27165 reword title of the project 1eaac7d reword title of the project bis a7419d6 fix broken links in changelog 26b0311 prepare v0.7.1 2b5e58e
142 lines
5.6 KiB
Markdown
142 lines
5.6 KiB
Markdown
# 📫 Himalaya [](https://github.com/soywod/himalaya/releases/latest) [](https://matrix.to/#/#pimalaya.himalaya:matrix.org)
|
|
|
|
Himalaya is a CLI based on the
|
|
[himalaya-lib](https://git.sr.ht/~soywod/himalaya-lib) that allows you
|
|
to manipulate your emails using commands in your console.
|
|
|
|
|
|
|
|
*Disclaimer: the project is under active development, do not use in
|
|
production before the `v1.0.0`.*
|
|
|
|
## Features
|
|
|
|
- [Folder listing]
|
|
- [Envelopes listing], [searching] and [sorting]
|
|
- [Email composition] based on `$EDITOR`
|
|
- Email manipulation ([copy]/[move]/[delete])
|
|
- [Multi-accounting]
|
|
- [Account listing]
|
|
- [Account synchronization] for offline usage
|
|
- IMAP, Maildir and Notmuch support
|
|
- IMAP IDLE mode for [real-time notifications]
|
|
- PGP end-to-end encryption
|
|
- [Completions] for various shells
|
|
- JSON output
|
|
- …
|
|
|
|
[Folder listing]: https://pimalaya.org/himalaya/docs/cli/usage/folders/list.html
|
|
[Envelopes listing]: https://pimalaya.org/himalaya/docs/cli/usage/envelopes/list.html
|
|
[searching]: https://pimalaya.org/himalaya/docs/cli/usage/envelopes/search.html
|
|
[sorting]: https://pimalaya.org/himalaya/docs/cli/usage/envelopes/sort.html
|
|
[Email composition]: https://pimalaya.org/himalaya/docs/cli/usage/emails/write.html
|
|
[copy]: https://pimalaya.org/himalaya/docs/cli/usage/emails/copy.html
|
|
[move]: https://pimalaya.org/himalaya/docs/cli/usage/emails/move.html
|
|
[delete]: https://pimalaya.org/himalaya/docs/cli/usage/emails/delete.html
|
|
[Multi-accounting]: https://pimalaya.org/himalaya/docs/cli/configuration.html
|
|
[Account listing]: https://pimalaya.org/himalaya/docs/cli/usage/accounts/list.html
|
|
[Account synchronization]: https://pimalaya.org/himalaya/docs/cli/usage/accounts/synchronize.html
|
|
[real-time notifications]: https://pimalaya.org/himalaya/docs/cli/usage/notifications.html
|
|
[Completions]: https://pimalaya.org/himalaya/docs/cli/tips/completion.html
|
|
|
|
## Installation
|
|
|
|
<table align="center">
|
|
<tr>
|
|
<td width="50%">
|
|
<a href="https://repology.org/project/himalaya/versions">
|
|
<img src="https://repology.org/badge/vertical-allrepos/himalaya.svg" alt="Packaging status" />
|
|
</a>
|
|
</td>
|
|
<td width="50%">
|
|
|
|
```bash
|
|
# Arch Linux (official)
|
|
$ pacman -S himalaya
|
|
|
|
# Arch Linux (from sources)
|
|
$ yay -S himalaya-git
|
|
|
|
# Homebrew
|
|
$ brew install himalaya
|
|
|
|
# Cargo
|
|
$ cargo install himalaya
|
|
|
|
# Nix
|
|
$ nix-env -i himalaya
|
|
```
|
|
|
|
*See the
|
|
[documentation](https://pimalaya.org/himalaya/docs/cli/installation.html)
|
|
for other installation methods.*
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Configuration
|
|
|
|
Please read the
|
|
[documentation](https://pimalaya.org/himalaya/docs/cli/configuration.html).
|
|
|
|
## Contributing
|
|
|
|
If you find a **bug**, please send an email at
|
|
[~soywod/pimalaya@todo.sr.ht](mailto:~soywod/pimalaya@todo.sr.ht).
|
|
|
|
If you have a **question**, please send an email at
|
|
[~soywod/pimalaya@lists.sr.ht](mailto:~soywod/pimalaya@lists.sr.ht).
|
|
|
|
If you want to **propose a feature** or **fix a bug**, please send a
|
|
patch at
|
|
[~soywod/pimalaya@lists.sr.ht](mailto:~soywod/pimalaya@lists.sr.ht)
|
|
using [git send-email](https://git-scm.com/docs/git-send-email) (see
|
|
[this guide](https://git-send-email.io/) on how to configure it).
|
|
|
|
If you want to **subscribe** to the mailing list, please send an email
|
|
at
|
|
[~soywod/pimalaya+subscribe@lists.sr.ht](mailto:~soywod/pimalaya+subscribe@lists.sr.ht).
|
|
|
|
If you want to **unsubscribe** to the mailing list, please send an
|
|
email at
|
|
[~soywod/pimalaya+unsubscribe@lists.sr.ht](mailto:~soywod/pimalaya+unsubscribe@lists.sr.ht).
|
|
|
|
If you want to **discuss** about the project, feel free to join the
|
|
[Matrix](https://matrix.org/) workspace
|
|
[#pimalaya.himalaya](https://matrix.to/#/#pimalaya.himalaya:matrix.org) or contact me
|
|
directly [@soywod](https://matrix.to/#/@soywod:matrix.org).
|
|
|
|
## Credits
|
|
|
|
[](https://nlnet.nl/project/Himalaya/index.html)
|
|
|
|
Special thanks to the
|
|
[nlnet](https://nlnet.nl/project/Himalaya/index.html) foundation that
|
|
helped Himalaya to receive financial support from the [NGI
|
|
Assure](https://www.ngi.eu/ngi-projects/ngi-assure/) program of the
|
|
European Commission in September, 2022.
|
|
|
|
* [himalaya-lib](https://git.sr.ht/~soywod/himalaya-lib)
|
|
* [IMAP RFC3501](https://tools.ietf.org/html/rfc3501)
|
|
* [Iris](https://github.com/soywod/iris.vim), the himalaya predecessor
|
|
* [isync](https://isync.sourceforge.io/), an email synchronizer for
|
|
offline usage
|
|
* [NeoMutt](https://neomutt.org/), an email terminal user interface
|
|
* [Alpine](http://alpine.x10host.com/alpine/alpine-info/), an other
|
|
email terminal user interface
|
|
* [mutt-wizard](https://github.com/LukeSmithxyz/mutt-wizard), a tool
|
|
over NeoMutt and isync
|
|
* [rust-imap](https://github.com/jonhoo/rust-imap), a Rust IMAP
|
|
library
|
|
* [lettre](https://github.com/lettre/lettre), a Rust mailer library
|
|
* [mailparse](https://github.com/staktrace/mailparse), a Rust MIME
|
|
email parser.
|
|
|
|
## Sponsoring
|
|
|
|
[](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)
|