mirror of
https://github.com/soywod/himalaya.git
synced 2024-07-05 09:05:13 +00:00
107 lines
3.5 KiB
Markdown
107 lines
3.5 KiB
Markdown
# 📫 Himalaya
|
|
|
|
Command-line interface for email management
|
|
|
|
*The project is under active development. Do not use in production
|
|
before the `v1.0.0`.*
|
|
|
|
|
|
|
|
## Motivation
|
|
|
|
Bringing emails to the terminal is a *pain*. First, because they are
|
|
sensitive data. Secondly, the existing TUIs
|
|
([Mutt](http://www.mutt.org/), [NeoMutt](https://neomutt.org/),
|
|
[Alpine](https://alpine.x10host.com/),
|
|
[aerc](https://aerc-mail.org/)…) are really hard to configure. They
|
|
require time and patience.
|
|
|
|
The aim of Himalaya is to extract the email logic into a simple (yet
|
|
solid) CLI API that can be used directly from the terminal, from
|
|
scripts, from UIs… Possibilities are endless!
|
|
|
|
## Installation
|
|
|
|
[](https://formulae.brew.sh/formula/himalaya)
|
|
[](https://crates.io/crates/himalaya)
|
|
|
|
```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
|
|
|
|
name = "Your full name"
|
|
downloads-dir = "/abs/path/to/downloads"
|
|
signature = """
|
|
Cordialement,
|
|
Regards,
|
|
"""
|
|
|
|
[gmail]
|
|
default = true
|
|
email = "your.email@gmail.com"
|
|
|
|
imap-host = "imap.gmail.com"
|
|
imap-port = 993
|
|
imap-login = "your.email@gmail.com"
|
|
imap-passwd-cmd = "pass show gmail"
|
|
|
|
smtp-host = "smtp.gmail.com"
|
|
smtp-port = 465
|
|
smtp-login = "your.email@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
|
|
|
|
- Mailbox 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:msg:list) for all
|
|
the features.*
|
|
|
|
## 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)
|
|
|
|
## Credits
|
|
|
|
- [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
|