beenull/himalaya
1
0
Fork 0
mirror of https://github.com/soywod/himalaya.git synced 2024-11-22 02:50:19 +00:00
Code Issues Projects Releases Packages Wiki Activity
himalaya/README.md

95 lines
3.1 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
add changelog and license files
2020-12-24 23:36:24 +00:00
update readme
2022-09-25 22:08:46 +00:00
Command-line interface for email management based on the
[himalaya-lib](https://git.sr.ht/~soywod/himalaya-lib).
add readme warning about production usage
2021-03-19 21:18:05 +00:00
release v0.5.5 (#290) * update main screenshot readme * add contributing file * update changelog * doc: remove roadmap from reame * improve main comments * improve arg and handler logs * fix multiple recipients issue (#288) * add notify-query config option (#289) * set up end-to-end encryption (#287) * init basic pgp encrypt/decrypt * add small rpgp poc for (#286) * improve decrypt parts logs * add pgp-decrypt-cmd to config * add pgp-encrypt-cmd to config * init pgp signature * improve decrypt part readability * improve encrypt multipart, remove sign * remove unused md5 lib * add encrypt arg to reply and forward commands * fix typos * prepare v0.5.5
2022-02-08 13:50:09 +00:00
![image](https://user-images.githubusercontent.com/10437171/138774902-7b9de5a3-93eb-44b0-8cfb-6d2e11e3b1aa.png)
improve readme
2021-01-17 15:03:38 +00:00
update readme
2022-09-25 22:08:46 +00:00
*The project is under active development. Do not use in production
before the `v1.0.0`.*
improve readme
2021-01-17 15:03:38 +00:00
## Installation
replace badges by repology big one
2022-10-11 14:43:55 +00:00
[![Packaging
status](https://repology.org/badge/vertical-allrepos/himalaya.svg)](https://repology.org/project/himalaya/versions)
prepare cargo publishing
2022-02-03 14:22:34 +00:00
update readme badges
2022-02-03 23:23:02 +00:00
```sh
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
```
release v0.5.6 (#301) * make use of mailparse::MailAddr * move addr logic to a dedicated file * update changelog * add suffix to downoalded attachments with same name (#204) * implement sort command (#34) * introduce backends structure (#296) * implement backend structure poc * improve config namings * improve account namings and structure * rename imap vars to backend * maildir backend (#299) * refactor config system, preparing maildir backend * rename deserializable by deserialized * wrap backend in a Box * reword backend trait methods * merge list envelopes functions * remove find_raw_msg from backend trait * remove expunge fn from backend trait * rename add_msg from backend trait * init maildir integration tests, start impl maildir backend fns * implement remaining methods maildir backend, refactor trait * improve backend trait, add copy and move fns * remove usage of Mbox in handlers * reorganize backends folder structure * move mbox out of domain folder * rename mbox entities * improve mbox structure * remove unused files, move smtp module * improve envelope, impl get_envelopes for maildir * link maildir mail entry id to envelope id * use erased-serde to make backend get_mboxes return a trait object * remove unused mbox files * rename Output trait * make get_envelopes return a trait object * remove unused impl for imap envelope * update backend return signature with Box * replace impl from imap::Fetch to mailparse::ParsedMail * split flags by backends * remove unused flags from msg * remove remaining flags from domain * impl maildir copy and move, improve maildir e2e tests * set up imap backend e2e tests * move domain/msg to msg * repair broken tests * fix maildir envelopes encoding issues * add date column to maildir envelopes * implement maildir list pagination * improve maildir subdir path management * add pgp and maildir features to readme * update changelog * bump version v0.5.6
2022-02-22 15:54:39 +00:00
*See the
fix broken link to wiki on binary installation (#304)
2022-02-23 10:03:51 +00:00
[wiki](https://github.com/soywod/himalaya/wiki/Installation:binary)
release v0.5.6 (#301) * make use of mailparse::MailAddr * move addr logic to a dedicated file * update changelog * add suffix to downoalded attachments with same name (#204) * implement sort command (#34) * introduce backends structure (#296) * implement backend structure poc * improve config namings * improve account namings and structure * rename imap vars to backend * maildir backend (#299) * refactor config system, preparing maildir backend * rename deserializable by deserialized * wrap backend in a Box * reword backend trait methods * merge list envelopes functions * remove find_raw_msg from backend trait * remove expunge fn from backend trait * rename add_msg from backend trait * init maildir integration tests, start impl maildir backend fns * implement remaining methods maildir backend, refactor trait * improve backend trait, add copy and move fns * remove usage of Mbox in handlers * reorganize backends folder structure * move mbox out of domain folder * rename mbox entities * improve mbox structure * remove unused files, move smtp module * improve envelope, impl get_envelopes for maildir * link maildir mail entry id to envelope id * use erased-serde to make backend get_mboxes return a trait object * remove unused mbox files * rename Output trait * make get_envelopes return a trait object * remove unused impl for imap envelope * update backend return signature with Box * replace impl from imap::Fetch to mailparse::ParsedMail * split flags by backends * remove unused flags from msg * remove remaining flags from domain * impl maildir copy and move, improve maildir e2e tests * set up imap backend e2e tests * move domain/msg to msg * repair broken tests * fix maildir envelopes encoding issues * add date column to maildir envelopes * implement maildir list pagination * improve maildir subdir path management * add pgp and maildir features to readme * update changelog * bump version v0.5.6
2022-02-22 15:54:39 +00:00
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
update lib v0.3.1, use MIT license
2022-10-10 16:06:13 +00:00
display-name = "Test"
downloads-dir = "~/downloads"
signature = "Regards,"
improve readme
2021-01-17 15:03:38 +00:00
[gmail]
default = true
update lib v0.3.1, use MIT license
2022-10-10 16:06:13 +00:00
email = "test@gmail.com"
improve readme
2021-01-17 15:03:38 +00:00
update lib v0.3.1, use MIT license
2022-10-10 16:06:13 +00:00
backend = "imap" # imap, maildir or notmuch
improve readme
2021-03-10 21:35:06 +00:00
imap-host = "imap.gmail.com"
imap-port = 993
update lib v0.3.1, use MIT license
2022-10-10 16:06:13 +00:00
imap-login = "test@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
update lib v0.3.1, use MIT license
2022-10-10 16:06:13 +00:00
sender = "smtp" # smtp or sendmail
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
update lib v0.3.1, use MIT license
2022-10-10 16:06:13 +00:00
smtp-login = "test@gmail.com"
rename idle notify cmd
2021-03-11 23:07:01 +00:00
smtp-passwd-cmd = "security find-internet-password -gs gmail -w"
improve readme
2021-01-17 15:03:38 +00:00
```
release v0.5.6 (#301) * make use of mailparse::MailAddr * move addr logic to a dedicated file * update changelog * add suffix to downoalded attachments with same name (#204) * implement sort command (#34) * introduce backends structure (#296) * implement backend structure poc * improve config namings * improve account namings and structure * rename imap vars to backend * maildir backend (#299) * refactor config system, preparing maildir backend * rename deserializable by deserialized * wrap backend in a Box * reword backend trait methods * merge list envelopes functions * remove find_raw_msg from backend trait * remove expunge fn from backend trait * rename add_msg from backend trait * init maildir integration tests, start impl maildir backend fns * implement remaining methods maildir backend, refactor trait * improve backend trait, add copy and move fns * remove usage of Mbox in handlers * reorganize backends folder structure * move mbox out of domain folder * rename mbox entities * improve mbox structure * remove unused files, move smtp module * improve envelope, impl get_envelopes for maildir * link maildir mail entry id to envelope id * use erased-serde to make backend get_mboxes return a trait object * remove unused mbox files * rename Output trait * make get_envelopes return a trait object * remove unused impl for imap envelope * update backend return signature with Box * replace impl from imap::Fetch to mailparse::ParsedMail * split flags by backends * remove unused flags from msg * remove remaining flags from domain * impl maildir copy and move, improve maildir e2e tests * set up imap backend e2e tests * move domain/msg to msg * repair broken tests * fix maildir envelopes encoding issues * add date column to maildir envelopes * implement maildir list pagination * improve maildir subdir path management * add pgp and maildir features to readme * update changelog * bump version v0.5.6
2022-02-22 15:54:39 +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
improve args management
2022-09-27 15:37:08 +00:00
- Folder listing
update readme features section
2022-03-04 08:46:17 +00:00
- Email listing and searching
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
- Email composition based on `$EDITOR`
- Email manipulation (copy/move/delete)
- Multi-accounting
update readme features section
2022-03-04 08:46:17 +00:00
- Account listing
- IMAP, Maildir and Notmuch support
- IMAP IDLE mode for real-time notifications
release v0.5.6 (#301) * make use of mailparse::MailAddr * move addr logic to a dedicated file * update changelog * add suffix to downoalded attachments with same name (#204) * implement sort command (#34) * introduce backends structure (#296) * implement backend structure poc * improve config namings * improve account namings and structure * rename imap vars to backend * maildir backend (#299) * refactor config system, preparing maildir backend * rename deserializable by deserialized * wrap backend in a Box * reword backend trait methods * merge list envelopes functions * remove find_raw_msg from backend trait * remove expunge fn from backend trait * rename add_msg from backend trait * init maildir integration tests, start impl maildir backend fns * implement remaining methods maildir backend, refactor trait * improve backend trait, add copy and move fns * remove usage of Mbox in handlers * reorganize backends folder structure * move mbox out of domain folder * rename mbox entities * improve mbox structure * remove unused files, move smtp module * improve envelope, impl get_envelopes for maildir * link maildir mail entry id to envelope id * use erased-serde to make backend get_mboxes return a trait object * remove unused mbox files * rename Output trait * make get_envelopes return a trait object * remove unused impl for imap envelope * update backend return signature with Box * replace impl from imap::Fetch to mailparse::ParsedMail * split flags by backends * remove unused flags from msg * remove remaining flags from domain * impl maildir copy and move, improve maildir e2e tests * set up imap backend e2e tests * move domain/msg to msg * repair broken tests * fix maildir envelopes encoding issues * add date column to maildir envelopes * implement maildir list pagination * improve maildir subdir path management * add pgp and maildir features to readme * update changelog * bump version v0.5.6
2022-02-22 15:54:39 +00:00
- PGP end-to-end encryption
update readme features section
2022-03-04 08:46:17 +00:00
- Vim and Emacs plugins
- Completions for various shells
refactor readme + wiki (#110) * make readme more concise * update wiki * update wiki links inside readme
2021-04-18 21:08:50 +00:00
- JSON output
- …
update doc/changelog about signature
2021-04-03 10:02:36 +00:00
release v0.5.6 (#301) * make use of mailparse::MailAddr * move addr logic to a dedicated file * update changelog * add suffix to downoalded attachments with same name (#204) * implement sort command (#34) * introduce backends structure (#296) * implement backend structure poc * improve config namings * improve account namings and structure * rename imap vars to backend * maildir backend (#299) * refactor config system, preparing maildir backend * rename deserializable by deserialized * wrap backend in a Box * reword backend trait methods * merge list envelopes functions * remove find_raw_msg from backend trait * remove expunge fn from backend trait * rename add_msg from backend trait * init maildir integration tests, start impl maildir backend fns * implement remaining methods maildir backend, refactor trait * improve backend trait, add copy and move fns * remove usage of Mbox in handlers * reorganize backends folder structure * move mbox out of domain folder * rename mbox entities * improve mbox structure * remove unused files, move smtp module * improve envelope, impl get_envelopes for maildir * link maildir mail entry id to envelope id * use erased-serde to make backend get_mboxes return a trait object * remove unused mbox files * rename Output trait * make get_envelopes return a trait object * remove unused impl for imap envelope * update backend return signature with Box * replace impl from imap::Fetch to mailparse::ParsedMail * split flags by backends * remove unused flags from msg * remove remaining flags from domain * impl maildir copy and move, improve maildir e2e tests * set up imap backend e2e tests * move domain/msg to msg * repair broken tests * fix maildir envelopes encoding issues * add date column to maildir envelopes * implement maildir list pagination * improve maildir subdir path management * add pgp and maildir features to readme * update changelog * bump version v0.5.6
2022-02-22 15:54:39 +00:00
*See the
update lib v0.3.1, use MIT license
2022-10-10 16:06:13 +00:00
[wiki](https://github.com/soywod/himalaya/wiki/Usage:email:list) for
all the features.*
update sponsoring sections
2021-04-16 19:47:08 +00:00
improve readme
2021-01-17 15:03:38 +00:00
## Credits
update readme
2022-09-25 22:08:46 +00:00
- [himalaya-lib](https://git.sr.ht/~soywod/himalaya-lib)
improve readme
2021-01-17 15:03:38 +00:00
- [IMAP RFC3501](https://tools.ietf.org/html/rfc3501)
- [Iris](https://github.com/soywod/iris.vim), the himalaya predecessor
release v0.5.6 (#301) * make use of mailparse::MailAddr * move addr logic to a dedicated file * update changelog * add suffix to downoalded attachments with same name (#204) * implement sort command (#34) * introduce backends structure (#296) * implement backend structure poc * improve config namings * improve account namings and structure * rename imap vars to backend * maildir backend (#299) * refactor config system, preparing maildir backend * rename deserializable by deserialized * wrap backend in a Box * reword backend trait methods * merge list envelopes functions * remove find_raw_msg from backend trait * remove expunge fn from backend trait * rename add_msg from backend trait * init maildir integration tests, start impl maildir backend fns * implement remaining methods maildir backend, refactor trait * improve backend trait, add copy and move fns * remove usage of Mbox in handlers * reorganize backends folder structure * move mbox out of domain folder * rename mbox entities * improve mbox structure * remove unused files, move smtp module * improve envelope, impl get_envelopes for maildir * link maildir mail entry id to envelope id * use erased-serde to make backend get_mboxes return a trait object * remove unused mbox files * rename Output trait * make get_envelopes return a trait object * remove unused impl for imap envelope * update backend return signature with Box * replace impl from imap::Fetch to mailparse::ParsedMail * split flags by backends * remove unused flags from msg * remove remaining flags from domain * impl maildir copy and move, improve maildir e2e tests * set up imap backend e2e tests * move domain/msg to msg * repair broken tests * fix maildir envelopes encoding issues * add date column to maildir envelopes * implement maildir list pagination * improve maildir subdir path management * add pgp and maildir features to readme * update changelog * bump version v0.5.6
2022-02-22 15:54:39 +00:00
- [isync](https://isync.sourceforge.io/), an email synchronizer for
offline usage
release v0.2.0
2021-03-10 22:08:31 +00:00
- [NeoMutt](https://neomutt.org/), an email terminal user interface
release v0.5.6 (#301) * make use of mailparse::MailAddr * move addr logic to a dedicated file * update changelog * add suffix to downoalded attachments with same name (#204) * implement sort command (#34) * introduce backends structure (#296) * implement backend structure poc * improve config namings * improve account namings and structure * rename imap vars to backend * maildir backend (#299) * refactor config system, preparing maildir backend * rename deserializable by deserialized * wrap backend in a Box * reword backend trait methods * merge list envelopes functions * remove find_raw_msg from backend trait * remove expunge fn from backend trait * rename add_msg from backend trait * init maildir integration tests, start impl maildir backend fns * implement remaining methods maildir backend, refactor trait * improve backend trait, add copy and move fns * remove usage of Mbox in handlers * reorganize backends folder structure * move mbox out of domain folder * rename mbox entities * improve mbox structure * remove unused files, move smtp module * improve envelope, impl get_envelopes for maildir * link maildir mail entry id to envelope id * use erased-serde to make backend get_mboxes return a trait object * remove unused mbox files * rename Output trait * make get_envelopes return a trait object * remove unused impl for imap envelope * update backend return signature with Box * replace impl from imap::Fetch to mailparse::ParsedMail * split flags by backends * remove unused flags from msg * remove remaining flags from domain * impl maildir copy and move, improve maildir e2e tests * set up imap backend e2e tests * move domain/msg to msg * repair broken tests * fix maildir envelopes encoding issues * add date column to maildir envelopes * implement maildir list pagination * improve maildir subdir path management * add pgp and maildir features to readme * update changelog * bump version v0.5.6
2022-02-22 15:54:39 +00:00
- [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
release v0.2.0
2021-03-10 22:08:31 +00:00
- [rust-imap](https://github.com/jonhoo/rust-imap), a rust IMAP lib
update lib v0.3.1, use MIT license
2022-10-10 16:06:13 +00:00
## Sponsoring
[![github](https://img.shields.io/badge/-GitHub%20Sponsors-fafbfc?logo=GitHub%20Sponsors&style=flat-square)](https://github.com/sponsors/soywod)
[![paypal](https://img.shields.io/badge/-PayPal-0079c1?logo=PayPal&logoColor=ffffff&style=flat-square)](https://www.paypal.com/paypalme/soywod)
[![ko-fi](https://img.shields.io/badge/-Ko--fi-ff5e5a?logo=Ko-fi&logoColor=ffffff&style=flat-square)](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&style=flat-square)](https://www.buymeacoffee.com/soywod)
[![liberapay](https://img.shields.io/badge/-Liberapay-f6c915?logo=Liberapay&logoColor=222222&style=flat-square)](https://liberapay.com/soywod)
Reference in a new issue Copy permalink