beenull/himalaya
1
0
Fork 0
mirror of https://github.com/soywod/himalaya.git synced 2024-11-25 20:40:24 +00:00
Code Issues Projects Releases Packages Wiki Activity
himalaya/README.md

102 lines
3.9 KiB
Markdown
Raw Normal View History

add homebrew release badge (#165) * doc: add homebrew install Signed-off-by: Rui Chen <rui@chenrui.dev> * doc: add homebrew release badge Signed-off-by: Rui Chen <rui@chenrui.dev> * remove brew installation from README
2021-07-01 08:27:22 +00:00
# 📫 Himalaya
[![gh-actions](https://github.com/soywod/himalaya/workflows/deployment/badge.svg)](https://github.com/soywod/himalaya/actions?query=workflow%3Adeployment)
[![gh-actions](https://github.com/soywod/himalaya/workflows/tests/badge.svg)](https://github.com/soywod/himalaya/actions?query=workflow%3Atests)
[![gh-actions](https://github.com/soywod/himalaya/workflows/nix-build/badge.svg)](https://github.com/soywod/himalaya/actions?query=workflow%3Anix-build)
[![Homebrew](https://img.shields.io/badge/dynamic/json.svg?url=https://formulae.brew.sh/api/formula/himalaya.json&query=$.versions.stable&label=homebrew)](https://formulae.brew.sh/formula/himalaya)
add changelog and license files
2020-12-24 23:36:24 +00:00
refactor table system (#132) * init table trait * add shrink_col_index and max_width method to Table trait * make unicodes work when shrinking * improve readability of the table * replace old table system with new one * update changelog
2021-04-27 12:54:53 +00:00
CLI email client written in Rust.
add help entry to readme
2021-01-02 23:49:51 +00:00
add readme warning about production usage
2021-03-19 21:18:05 +00:00
*The project is under active development. Do not use in production before the
update roadmap link readme
2021-04-17 22:29:45 +00:00
`v1.0.0` (see the [roadmap](https://github.com/soywod/himalaya/milestone/5)).*
add readme warning about production usage
2021-03-19 21:18:05 +00:00
update readme main img
2021-04-27 23:06:39 +00:00
![image](https://user-images.githubusercontent.com/10437171/115144003-8a1b4880-a04a-11eb-80d2-245027e28591.png)
improve readme
2021-01-17 15:03:38 +00:00
## Motivation
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
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.
improve readme
2021-01-17 15:03:38 +00:00
release v0.2.0
2021-03-10 22:08:31 +00:00
The aim of Himalaya is to extract the email logic into a simple (yet solid) CLI
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
API that can be used directly from the terminal, from scripts, from UIs…
Possibilities are endless!
improve readme
2021-01-17 15:03:38 +00:00
## Installation
improve portability of install.sh (#107) * Replace echo with printf The echo(1) command varies among sh implementations. Some interpret hyphen command-line options. It would be unusual, but in theory if $PREFIX began with a hyphen or two then this usage of echo might cause an error or unknown behaviour in such implementations. The printf(1) command is consistent across shell implementations. * Leave privilege elevation to the user * Add die function * Break long line
2021-04-18 09:00:06 +00:00
```sh
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
# As root:
improve portability of install.sh (#107) * Replace echo with printf The echo(1) command varies among sh implementations. Some interpret hyphen command-line options. It would be unusual, but in theory if $PREFIX began with a hyphen or two then this usage of echo might cause an error or unknown behaviour in such implementations. The printf(1) command is consistent across shell implementations. * Leave privilege elevation to the user * Add die function * Break long line
2021-04-18 09:00:06 +00:00
curl -sSL https://raw.githubusercontent.com/soywod/himalaya/master/install.sh | sudo sh
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
# As a regular user:
improve portability of install.sh (#107) * Replace echo with printf The echo(1) command varies among sh implementations. Some interpret hyphen command-line options. It would be unusual, but in theory if $PREFIX began with a hyphen or two then this usage of echo might cause an error or unknown behaviour in such implementations. The printf(1) command is consistent across shell implementations. * Leave privilege elevation to the user * Add die function * Break long line
2021-04-18 09:00:06 +00:00
curl -sSL https://raw.githubusercontent.com/soywod/himalaya/master/install.sh | PREFIX=~/.local sh
improve readme
2021-01-17 15:03:38 +00:00
```
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
*See the [wiki](https://github.com/soywod/himalaya/wiki) for other installation
methods.*
add nix support (#76) * Add default.nix for nix support * Convert to flake * gitignore before building the source * Add default.nix and shell.nix for legacy workflows * Use https://github.com/oxalica/rust-overlay This one works for development workflow, with a functional rust-analyzer for using with language server support in IDEs. Also add .vscode/ for pre-configured settings. * Add documentation * Restore old TOC and apply TOC patch manually * Clarify that these two commands are either-or * Add installing from local checkout (nix-env) * Add note about version update * Improve Nix workflow, for zero maintenance Use https://github.com/nmattia/naersk This avoids having to set a sha and version in Nix scripts. * Simplify using crate2nix Ref: https://www.reddit.com/r/rust/comments/mmbfnj/nixifying_a_rust_project/ * Use rootCrate * Propagate openssl deps to non-shell build * Try the oxalica overlay * Get rid of gitignore crate cf. https://www.reddit.com/r/rust/comments/mmbfnj/nixifying_a_rust_project/gtsgxal/?context=3 * Configure himalaya crate under defaultCrateOverrides * Specify openssl in buildInputs * Make a note about a potential error when using Nix 2.4pre * Remove PKG_CONFIG_PATH (unnecessary) * Add cargo-watch Co-authored-by: Alexander Bantyev <balsoft@balsoft.ru> Co-authored-by: Alexander Bantyev <balsoft@balsoft.ru>
2021-04-17 22:06:11 +00:00
improve readme
2021-01-17 15:03:38 +00:00
## Configuration
```toml
# ~/.config/himalaya/config.toml
name = "Your full name"
improve readme
2021-03-10 21:35:06 +00:00
downloads-dir = "/abs/path/to/downloads"
improve signature and template management (#114) * Added signature seperator option plus some refactoring * Have add_content make newline seperation to headers * Remove signature separator as a separate argument
2021-04-20 09:23:03 +00:00
signature = """
--
Regards,
"""
improve readme
2021-01-17 15:03:38 +00:00
[gmail]
default = true
rename idle notify cmd
2021-03-11 23:07:01 +00:00
email = "your.email@gmail.com"
improve readme
2021-01-17 15:03:38 +00:00
improve readme
2021-03-10 21:35:06 +00:00
imap-host = "imap.gmail.com"
imap-port = 993
rename idle notify cmd
2021-03-11 23:07:01 +00:00
imap-login = "your.email@gmail.com"
add idle mode
2021-03-11 16:05:01 +00:00
imap-passwd-cmd = "pass show gmail"
improve readme
2021-01-17 15:03:38 +00:00
improve readme
2021-03-10 21:35:06 +00:00
smtp-host = "smtp.gmail.com"
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
smtp-port = 465
rename idle notify cmd
2021-03-11 23:07:01 +00:00
smtp-login = "your.email@gmail.com"
smtp-passwd-cmd = "security find-internet-password -gs gmail -w"
improve readme
2021-01-17 15:03:38 +00:00
```
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
*See the
[wiki](https://github.com/soywod/himalaya/wiki/Configuration:config-file) for
all the options.*
update doc/changelog about signature
2021-04-03 10:02:36 +00:00
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
## Features
update doc/changelog about signature
2021-04-03 10:02:36 +00:00
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
- 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
- …
update doc/changelog about signature
2021-04-03 10:02:36 +00:00
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
*See the [wiki](https://github.com/soywod/himalaya/wiki) for all the features.*
update doc/changelog about signature
2021-04-03 10:02:36 +00:00
update sponsoring sections
2021-04-16 19:47:08 +00:00
## Sponsoring
[![github](https://img.shields.io/badge/-GitHub%20Sponsors-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/soywod)
[![paypal](https://img.shields.io/badge/-PayPal-0079c1?logo=PayPal&logoColor=ffffff)](https://www.paypal.com/paypalme/soywod)
[![ko-fi](https://img.shields.io/badge/-Ko--fi-ff5e5a?logo=Ko-fi&logoColor=ffffff)](https://ko-fi.com/soywod)
[![buy-me-a-coffee](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ffdd00?logo=Buy%20Me%20A%20Coffee&logoColor=000000)](https://www.buymeacoffee.com/soywod)
refactor tpl system (#80)
2021-05-30 22:02:16 +00:00
[![liberapay](https://img.shields.io/badge/-Liberapay-f6c915?logo=Liberapay&logoColor=222222)](https://liberapay.com/soywod)
update sponsoring sections
2021-04-16 19:47:08 +00:00
improve readme
2021-01-17 15:03:38 +00:00
## Credits
- [IMAP RFC3501](https://tools.ietf.org/html/rfc3501)
- [Iris](https://github.com/soywod/iris.vim), the himalaya predecessor
release v0.2.0
2021-03-10 22:08:31 +00:00
- [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
Reference in a new issue Copy permalink