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

improve readme faq sections

Browse source
This commit is contained in:
Clément DOUIN 2024-08-27 10:47:35 +02:00
parent 3044dda8f4
commit bec2522e7f
No known key found for this signature in database
GPG key ID: 353E4A18EE0FAB72
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -488,7 +488,7 @@ You can also manually write your own configuration, from scratch:
Multiple address are separated by a coma `,`: `user@domain, Name <user@domain>, "Name" <user@domain>`.
### Body
### Plain text body
Email message template body can be written in plain text. The result will be compiled into a single `text/plain` MIME part:
@ -500,11 +500,13 @@ You can also manually write your own configuration, from scratch:
Hello, world!
```
Email message template body can also be written in MML (MIME Meta Language).
### MML boby
A raw email message is structured according to the [MIME](https://www.rfc-editor.org/rfc/rfc2045) standard. But it is not so user-friendly to use. Here comes MML: it simplifies the way email message body are structured. Thanks to its simple XML-based syntax, you can easily add multiple parts, attach a binary file, or attach inline image to your body.
Email message template body can also be written in MML. The MIME Meta Language was introduced by the Emacs [`mml`](https://www.gnu.org/software/emacs/manual/html_node/emacs-mime/Composing.html) ELisp module. Pimalaya [ported it in Rust](https://github.com/pimalaya/core/tree/master/mml).
For example, this MML template:
A raw email message is structured according to the [MIME](https://www.rfc-editor.org/rfc/rfc2045) standard. This standard produces verbose, non-friendly messages. Here comes MML: it simplifies the way email message body are structured. Thanks to its simple XML-based syntax, it allows you to easily add multiple parts, attach a binary file, or attach inline image to your body without dealing with the MIME standard.
For instance, this MML template:
```eml
From: alice@localhost
@ -518,7 +520,7 @@ You can also manually write your own configuration, from scratch:
<#/multipart>
```
is compiled into this valid (and way more verbose) MIME Message:
compiles into the following MIME Message:
```eml
Subject: MML simple