From bec2522e7fd141f62004f3b761b5305bf0bf7393 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20DOUIN?= Date: Tue, 27 Aug 2024 10:47:35 +0200 Subject: [PATCH] improve readme faq sections --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0e40b184..3bc12ad9 100644 --- a/README.md +++ b/README.md @@ -488,7 +488,7 @@ You can also manually write your own configuration, from scratch: Multiple address are separated by a coma `,`: `user@domain, Name , "Name" `. - ### 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