Skip to content

Commit 3de6d70

Browse files
committed
docs(readme): fix wrong titles
1 parent 04f73bb commit 3de6d70

File tree

1 file changed

+44
-48
lines changed

1 file changed

+44
-48
lines changed

README.md

Lines changed: 44 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<a href="https://github.com/pimalaya/himalaya/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/pimalaya/himalaya?color=success"/></a>
77
<a href="https://repology.org/project/himalaya/versions"><img alt="Repology" src="https://img.shields.io/repology/repositories/himalaya?color=success"></a>
88
<a href="https://matrix.to/#/#pimalaya:matrix.org"><img alt="Matrix" src="https://img.shields.io/badge/chat-%23pimalaya-blue?style=flat&logo=matrix&logoColor=white"/></a>
9-
<a href="https://fosstodon.org/@pimalaya"><img alt="Mastodon" src="https://img.shields.io/badge/social-%40pimalaya-blue?style=flat&logo=mastodon&logoColor=white"/></a>
9+
<a href="https://fosstodon.org/@pimalaya"><img alt="Mastodon" src="https://img.shields.io/badge/news-%40pimalaya-blue?style=flat&logo=mastodon&logoColor=white"/></a>
1010
</p>
1111
</div>
1212

@@ -229,68 +229,64 @@ You can also manually edit your own configuration, from scratch:
229229

230230
### Proton Mail
231231

232-
<details>
233-
<summary>Instructions</summary>
232+
When using Proton Bridge, emails are synchronized locally and exposed via a local IMAP/SMTP server. This implies 2 things:
234233

235-
When using Proton Bridge, emails are synchronized locally and exposed via a local IMAP/SMTP server. This implies 2 things:
234+
- Id order may be reversed or shuffled, but envelopes will still be sorted by date.
235+
- SSL/TLS needs to be deactivated manually.
236+
- The password to use is the one generated by Proton Bridge, not the one from your Proton Mail account.
236237

237-
- Id order may be reversed or shuffled, but envelopes will still be sorted by date.
238-
- SSL/TLS needs to be deactivated manually.
239-
- The password to use is the one generated by Proton Bridge, not the one from your Proton Mail account.
238+
```toml
239+
[accounts.proton]
240+
email = "example@proton.me"
240241

241-
```toml
242-
[accounts.proton]
243-
email = "example@proton.me"
244-
245-
backend.type = "imap"
246-
backend.host = "127.0.0.1"
247-
backend.port = 1143
248-
backend.encryption.type = "none"
249-
backend.login = "example@proton.me"
250-
backend.auth.type = "password"
251-
backend.auth.raw = "*****"
252-
253-
message.send.backend.type = "smtp"
254-
message.send.backend.host = "127.0.0.1"
255-
message.send.backend.port = 1025
256-
message.send.backend.encryption.type = "none"
257-
message.send.backend.login = "example@proton.me"
258-
message.send.backend.auth.type = "password"
259-
message.send.backend.auth.raw = "*****"
260-
```
242+
backend.type = "imap"
243+
backend.host = "127.0.0.1"
244+
backend.port = 1143
245+
backend.encryption.type = "none"
246+
backend.login = "example@proton.me"
247+
backend.auth.type = "password"
248+
backend.auth.raw = "*****"
261249

262-
If you still want to use TLS, you need to export the certificate generated by Proton Bridge, then give it to Himalaya:
250+
message.send.backend.type = "smtp"
251+
message.send.backend.host = "127.0.0.1"
252+
message.send.backend.port = 1025
253+
message.send.backend.encryption.type = "none"
254+
message.send.backend.login = "example@proton.me"
255+
message.send.backend.auth.type = "password"
256+
message.send.backend.auth.raw = "*****"
257+
```
263258

264-
```toml
265-
backend.encryption.type = "start-tls"
266-
backend.encryption.cert = "/path/to/exported/cert.pem"
267-
268-
message.send.backend.encryption.type = "start-tls"
269-
message.send.backend.encryption.cert = "/path/to/exported/cert.pem"
270-
```
259+
If you still want to use TLS, you need to export the certificate generated by Proton Bridge, then give it to Himalaya:
271260

272-
Keeping your password inside the configuration file is good for testing purpose, but it is not safe. You have 2 better alternatives:
261+
```toml
262+
backend.encryption.type = "start-tls"
263+
backend.encryption.cert = "/path/to/exported/cert.pem"
273264

274-
- Save your password in any password manager that can be queried via the CLI:
265+
message.send.backend.encryption.type = "start-tls"
266+
message.send.backend.encryption.cert = "/path/to/exported/cert.pem"
267+
```
275268

276-
```toml
277-
backend.auth.cmd = "pass show proton"
278-
```
269+
Keeping your password inside the configuration file is good for testing purpose, but it is not safe. You have 2 better alternatives:
279270

280-
- Use the global keyring of your system (requires the `keyring` cargo feature):
271+
- Save your password in any password manager that can be queried via the CLI:
281272

282-
```toml
283-
backend.auth.keyring = "proton-example"
284-
```
273+
```toml
274+
backend.auth.cmd = "pass show proton"
275+
```
285276

286-
Running `himalaya account configure proton` will ask for your IMAP password, just paste the one generated previously.
287-
</details>
277+
- Use the global keyring of your system (requires the `keyring` cargo feature):
278+
279+
```toml
280+
backend.auth.keyring = "proton-example"
281+
```
282+
283+
Running `himalaya account configure proton` will ask for your IMAP password, just paste the one generated previously.
288284

289285
### Gmail
290286

291287
Google passwords cannot be used directly. There is two ways to authenticate yourself:
292288

293-
### Using [App Passwords](https://support.google.com/mail/answer/185833)
289+
#### Using [App Passwords](https://support.google.com/mail/answer/185833)
294290

295291
This option is the simplest and the fastest. First, be sure that:
296292

@@ -426,7 +422,7 @@ Keeping your password inside the configuration file is good for testing purpose,
426422

427423
Running `himalaya account configure outlook` will ask for your IMAP password, just paste the one generated previously.
428424

429-
### Using OAuth 2.0
425+
#### Using OAuth 2.0
430426

431427
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:
432428

0 commit comments

Comments
 (0)