From 24bb6f10d7cae6be0fa65afe1f908f304a343fc4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20DOUIN?= Date: Tue, 12 Dec 2023 15:24:59 +0100 Subject: [PATCH] fix broken link in readme --- Cargo.toml | 4 ++-- README.md | 48 +++++++++++++++---------------------------- config.sample.toml | 3 +-- src/account/config.rs | 8 ++++---- 4 files changed, 24 insertions(+), 39 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0394966..c4f8bc9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,8 +7,8 @@ edition = "2021" license = "MIT" categories = ["command-line-interface", "command-line-utilities", "email"] keywords = ["cli", "mail", "email", "client", "imap"] -homepage = "https://pimalaya.org/himalaya" -documentation = "https://pimalaya.org/himalaya/" +homepage = "https://pimalaya.org/himalaya/cli/latest/" +documentation = "https://pimalaya.org/himalaya/cli/latest/" repository = "https://github.com/soywod/himalaya/" [package.metadata.docs.rs] diff --git a/README.md b/README.md index 0cbd544..62bd64a 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,28 @@ # 📫 Himalaya [![GitHub release](https://img.shields.io/github/v/release/soywod/himalaya?color=success)](https://github.com/soywod/himalaya/releases/latest) [![Matrix](https://img.shields.io/matrix/pimalaya.himalaya:matrix.org?color=success&label=chat)](https://matrix.to/#/#pimalaya.himalaya:matrix.org) -https://pimalaya.org/himalaya/ +https://pimalaya.org/himalaya/cli/latest/ -CLI to manage emails, based on [email-lib](https://sr.ht/~soywod/pimalaya/). +CLI to manage emails, based on [email-lib](https://crates.io/crates/email-lib). -![image](https://user-images.githubusercontent.com/10437171/138774902-7b9de5a3-93eb-44b0-8cfb-6d2e11e3b1aa.png) +![screenshot](https://user-images.githubusercontent.com/10437171/138774902-7b9de5a3-93eb-44b0-8cfb-6d2e11e3b1aa.png) *Disclaimer: the project is under active development, do not use in production before the `v1.0.0`.* ## Features -- [Folder listing] -- [Envelopes listing], [searching] and [sorting] -- [Email composition] based on `$EDITOR` -- Email manipulation ([copy]/[move]/[delete]) -- [Multi-accounting] -- [Account listing] -- [Account synchronization] for offline usage -- IMAP, Maildir and Notmuch support -- IMAP IDLE mode for [real-time notifications] -- PGP end-to-end encryption -- [Completions] for various shells +- [Mailbox management](https://pimalaya.org/himalaya/cli/latest/usage/folder/) +- [Envelopes listing](https://pimalaya.org/himalaya/cli/latest/usage/envelope/list.md) +- [Message composition](https://pimalaya.org/himalaya/cli/latest/usage/message/write.md) based on `$EDITOR` +- Message manipulation ([copy](https://pimalaya.org/himalaya/cli/latest/usage/message/copy.md)/[move](https://pimalaya.org/himalaya/cli/latest/usage/message/move.md)/[delete](https://pimalaya.org/himalaya/cli/latest/usage/message/delete.md)) +- [Multi-accounting](https://pimalaya.org/himalaya/cli/latest/configuration/) +- [Account synchronization](https://pimalaya.org/himalaya/cli/latest/usage/account/sync.md) for offline https://pimalaya.org/himalaya/cli/latest/usage +- Support for [IMAP](https://pimalaya.org/himalaya/cli/latest/configuration/imap.md), [Maildir](https://pimalaya.org/himalaya/cli/latest/configuration/maildir.md), [notmuch](https://pimalaya.org/himalaya/cli/latest/configuration/notmuch.md) +- Sending via [SMTP](https://pimalaya.org/himalaya/cli/latest/configuration/smtp.md) or [sendmail](https://pimalaya.org/himalaya/cli/latest/configuration/sendmail.md) +- [PGP](https://pimalaya.org/himalaya/cli/latest/configuration/pgp/) end-to-end encryption +- Generate [completion scripts](https://pimalaya.org/himalaya/cli/latest/tips/completion.md) for various shells +- Generate [man pages](https://pimalaya.org/himalaya/cli/latest/tips/man.md) - JSON output -- … - -[Folder listing]: https://pimalaya.org/himalaya/cli/usage/folders/list.html -[Envelopes listing]: https://pimalaya.org/himalaya/cli/usage/envelopes/list.html -[searching]: https://pimalaya.org/himalaya/cli/usage/envelopes/search.html -[sorting]: https://pimalaya.org/himalaya/cli/usage/envelopes/sort.html -[Email composition]: https://pimalaya.org/himalaya/cli/usage/emails/write.html -[copy]: https://pimalaya.org/himalaya/cli/usage/emails/copy.html -[move]: https://pimalaya.org/himalaya/cli/usage/emails/move.html -[delete]: https://pimalaya.org/himalaya/cli/usage/emails/delete.html -[Multi-accounting]: https://pimalaya.org/himalaya/cli/configuration/index.html -[Account listing]: https://pimalaya.org/himalaya/cli/usage/accounts/list.html -[Account synchronization]: https://pimalaya.org/himalaya/cli/usage/accounts/synchronize.html -[real-time notifications]: https://pimalaya.org/himalaya/cli/usage/notifications.html -[Completions]: https://pimalaya.org/himalaya/cli/tips/completion.html +- …and more! ## Installation @@ -73,7 +59,7 @@ $ dnf copr enable atim/himalaya $ dnf install himalaya ``` -*See the [documentation](https://pimalaya.org/himalaya/cli/installation/index.html) for other installation methods.* +*See the [documentation](https://pimalaya.org/himalaya/cli/latest/installation/) for other installation methods.* @@ -81,7 +67,7 @@ $ dnf install himalaya ## Configuration -Please read the [documentation](https://pimalaya.org/himalaya/cli/configuration/index.html). +Please read the [documentation](https://pimalaya.org/himalaya/cli/latest/configuration/). ## Contributing diff --git a/config.sample.toml b/config.sample.toml index e7b3eff..ea15584 100644 --- a/config.sample.toml +++ b/config.sample.toml @@ -1,6 +1,5 @@ [example] -# Make this account the default one to use when no account is given to -# commands. +# The current account will be used by default for all other commands. default = true # The display-name and the email are used to build the full email diff --git a/src/account/config.rs b/src/account/config.rs index 85078be..389700b 100644 --- a/src/account/config.rs +++ b/src/account/config.rs @@ -26,22 +26,22 @@ use crate::{ #[serde(rename_all = "kebab-case")] pub struct TomlAccountConfig { pub default: Option, - pub email: String, pub display_name: Option, pub signature: Option, pub signature_delim: Option, pub downloads_dir: Option, + pub backend: Option, pub sync: Option, + #[cfg(feature = "pgp")] + pub pgp: Option, + pub folder: Option, pub envelope: Option, pub flag: Option, pub message: Option, - #[cfg(feature = "pgp")] - pub pgp: Option, - pub backend: Option, #[cfg(feature = "maildir")] pub maildir: Option, #[cfg(feature = "imap")]