mirror of
https://github.com/soywod/himalaya.git
synced 2024-11-22 11:00:19 +00:00
97 lines
3.7 KiB
Markdown
97 lines
3.7 KiB
Markdown
# 📫 Himalaya [](https://github.com/soywod/himalaya/actions?query=workflow%3Adeployment) [](https://github.com/soywod/himalaya/actions?query=workflow%3Atests) [](https://github.com/soywod/himalaya/actions?query=workflow%3Anix-build)
|
|
|
|
CLI email client written in Rust.
|
|
|
|
*The project is under active development. Do not use in production before the
|
|
`v1.0.0` (see the [roadmap](https://github.com/soywod/himalaya/milestone/5)).*
|
|
|
|
|
|
|
|
## 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
|
|
|
|
```sh
|
|
# As root:
|
|
curl -sSL https://raw.githubusercontent.com/soywod/himalaya/master/install.sh | sudo sh
|
|
|
|
# As a regular user:
|
|
curl -sSL https://raw.githubusercontent.com/soywod/himalaya/master/install.sh | PREFIX=~/.local sh
|
|
```
|
|
|
|
*See the [wiki](https://github.com/soywod/himalaya/wiki) for other installation
|
|
methods.*
|
|
|
|
## Configuration
|
|
|
|
```toml
|
|
# ~/.config/himalaya/config.toml
|
|
|
|
name = "Your full name"
|
|
downloads-dir = "/abs/path/to/downloads"
|
|
signature = """
|
|
--
|
|
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 filtering
|
|
- Email composition based on `$EDITOR`
|
|
- Email manipulation (copy/move/delete)
|
|
- Multi-accounting
|
|
- IDLE mode for real-time notifications
|
|
- Vim plugin
|
|
- Completions for bash/zsh/fish
|
|
- JSON output
|
|
- …
|
|
|
|
*See the [wiki](https://github.com/soywod/himalaya/wiki) 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
|