mirror of
https://github.com/soywod/himalaya.git
synced 2024-11-22 02:50:19 +00:00
285d9d0521
As more distributions start to package himalaya I think this information might be useful. Co-authored-by: Clément DOUIN <clement.douin@posteo.net>
95 lines
3.3 KiB
Markdown
95 lines
3.3 KiB
Markdown
# 📫 Himalaya
|
|
|
|
Command-line interface for email management based on the
|
|
[himalaya-lib](https://git.sr.ht/~soywod/himalaya-lib).
|
|
|
|
|
|
|
|
*The project is under active development. Do not use in production
|
|
before the `v1.0.0`.*
|
|
|
|
## Installation
|
|
|
|
[](https://formulae.brew.sh/formula/himalaya)
|
|
[](https://crates.io/crates/himalaya)
|
|
[](https://repology.org/project/himalaya/versions)
|
|
|
|
```sh
|
|
curl -sSL https://raw.githubusercontent.com/soywod/himalaya/master/install.sh | PREFIX=~/.local sh
|
|
```
|
|
|
|
*See the
|
|
[wiki](https://github.com/soywod/himalaya/wiki/Installation:binary)
|
|
for other installation methods.*
|
|
|
|
## Configuration
|
|
|
|
```toml
|
|
# ~/.config/himalaya/config.toml
|
|
|
|
display-name = "Test"
|
|
downloads-dir = "~/downloads"
|
|
signature = "Regards,"
|
|
|
|
[gmail]
|
|
default = true
|
|
email = "test@gmail.com"
|
|
|
|
backend = "imap" # imap, maildir or notmuch
|
|
imap-host = "imap.gmail.com"
|
|
imap-port = 993
|
|
imap-login = "test@gmail.com"
|
|
imap-passwd-cmd = "pass show gmail"
|
|
|
|
sender = "smtp" # smtp or sendmail
|
|
smtp-host = "smtp.gmail.com"
|
|
smtp-port = 465
|
|
smtp-login = "test@gmail.com"
|
|
smtp-passwd-cmd = "security find-internet-password -gs gmail -w"
|
|
```
|
|
|
|
*See the
|
|
[wiki](https://github.com/soywod/himalaya/wiki/Configuration:config-file)
|
|
for all the options.*
|
|
|
|
## Features
|
|
|
|
- Folder listing
|
|
- Email listing and searching
|
|
- Email composition based on `$EDITOR`
|
|
- Email manipulation (copy/move/delete)
|
|
- Multi-accounting
|
|
- Account listing
|
|
- IMAP, Maildir and Notmuch support
|
|
- IMAP IDLE mode for real-time notifications
|
|
- PGP end-to-end encryption
|
|
- Vim and Emacs plugins
|
|
- Completions for various shells
|
|
- JSON output
|
|
- …
|
|
|
|
*See the
|
|
[wiki](https://github.com/soywod/himalaya/wiki/Usage:email:list) for
|
|
all the features.*
|
|
|
|
## Credits
|
|
|
|
- [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 lib
|
|
|
|
## 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)
|