From 3de6d70bfecbc3ef6d4679811d6a85f0a30fcba5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20DOUIN?= Date: Mon, 9 Feb 2026 13:52:44 +0100 Subject: [PATCH] docs(readme): fix wrong titles --- README.md | 94 ++++++++++++++++++++++++++----------------------------- 1 file changed, 45 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index b6bc12b9..767ca407 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Release Repology Matrix - Mastodon + Mastodon

@@ -229,68 +229,64 @@ You can also manually edit your own configuration, from scratch: ### Proton Mail -
- Instructions +When using Proton Bridge, emails are synchronized locally and exposed via a local IMAP/SMTP server. This implies 2 things: - When using Proton Bridge, emails are synchronized locally and exposed via a local IMAP/SMTP server. This implies 2 things: +- Id order may be reversed or shuffled, but envelopes will still be sorted by date. +- SSL/TLS needs to be deactivated manually. +- The password to use is the one generated by Proton Bridge, not the one from your Proton Mail account. - - Id order may be reversed or shuffled, but envelopes will still be sorted by date. - - SSL/TLS needs to be deactivated manually. - - The password to use is the one generated by Proton Bridge, not the one from your Proton Mail account. +```toml +[accounts.proton] +email = "example@proton.me" + +backend.type = "imap" +backend.host = "127.0.0.1" +backend.port = 1143 +backend.encryption.type = "none" +backend.login = "example@proton.me" +backend.auth.type = "password" +backend.auth.raw = "*****" + +message.send.backend.type = "smtp" +message.send.backend.host = "127.0.0.1" +message.send.backend.port = 1025 +message.send.backend.encryption.type = "none" +message.send.backend.login = "example@proton.me" +message.send.backend.auth.type = "password" +message.send.backend.auth.raw = "*****" +``` + +If you still want to use TLS, you need to export the certificate generated by Proton Bridge, then give it to Himalaya: + +```toml +backend.encryption.type = "start-tls" +backend.encryption.cert = "/path/to/exported/cert.pem" + +message.send.backend.encryption.type = "start-tls" +message.send.backend.encryption.cert = "/path/to/exported/cert.pem" +``` + +Keeping your password inside the configuration file is good for testing purpose, but it is not safe. You have 2 better alternatives: + +- Save your password in any password manager that can be queried via the CLI: ```toml - [accounts.proton] - email = "example@proton.me" - - backend.type = "imap" - backend.host = "127.0.0.1" - backend.port = 1143 - backend.encryption.type = "none" - backend.login = "example@proton.me" - backend.auth.type = "password" - backend.auth.raw = "*****" - - message.send.backend.type = "smtp" - message.send.backend.host = "127.0.0.1" - message.send.backend.port = 1025 - message.send.backend.encryption.type = "none" - message.send.backend.login = "example@proton.me" - message.send.backend.auth.type = "password" - message.send.backend.auth.raw = "*****" + backend.auth.cmd = "pass show proton" ``` - If you still want to use TLS, you need to export the certificate generated by Proton Bridge, then give it to Himalaya: +- Use the global keyring of your system (requires the `keyring` cargo feature): ```toml - backend.encryption.type = "start-tls" - backend.encryption.cert = "/path/to/exported/cert.pem" - - message.send.backend.encryption.type = "start-tls" - message.send.backend.encryption.cert = "/path/to/exported/cert.pem" + backend.auth.keyring = "proton-example" ``` - Keeping your password inside the configuration file is good for testing purpose, but it is not safe. You have 2 better alternatives: - - - Save your password in any password manager that can be queried via the CLI: - - ```toml - backend.auth.cmd = "pass show proton" - ``` - - - Use the global keyring of your system (requires the `keyring` cargo feature): - - ```toml - backend.auth.keyring = "proton-example" - ``` - - Running `himalaya account configure proton` will ask for your IMAP password, just paste the one generated previously. -
+ Running `himalaya account configure proton` will ask for your IMAP password, just paste the one generated previously. ### Gmail Google passwords cannot be used directly. There is two ways to authenticate yourself: -### Using [App Passwords](https://support.google.com/mail/answer/185833) +#### Using [App Passwords](https://support.google.com/mail/answer/185833) This option is the simplest and the fastest. First, be sure that: @@ -426,7 +422,7 @@ Keeping your password inside the configuration file is good for testing purpose, Running `himalaya account configure outlook` will ask for your IMAP password, just paste the one generated previously. -### Using OAuth 2.0 +#### Using OAuth 2.0 This option is the most secure but the hardest to configure. First, you need to get your OAuth 2.0 credentials by following [this guide](https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth). Once you get your client id and your client secret, you can configure your Himalaya account this way: