Deuxfleurs/eml-codec
15
1
Fork 0
Code Issues 10 Pull requests Projects Releases 2 Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Quentin 2023-07-23 12:33:49 +02:00
parent d0f346c92f
commit bdc5d19a1f
Signed by: quentin
GPG key ID: E9602264D639FF68
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -1,7 +1,11 @@
# imf-codec # eml-codec
**Work in progress, do not use in production** **⚠️ Work in progress, do not use in production**
**This is currently only a decoder (parser), encoding is not supported.** **⚠️ This is currently only a decoder (parser), encoding is not yet implemented.**
## About the name
This library does not aim at implementing a specific RFC, but to be a swiss-army knife to decode and encode ("codec") what is generaly considered an email (generally abbreviated "eml"), hence the name: **eml-codec**.
## Goals ## Goals
@ -29,7 +33,7 @@ Current known limitations/bugs:
## Design ## Design
*Todo* Speak about parser combinators.
## Testing strategy ## Testing strategy
@ -104,6 +108,7 @@ IANA references :
- (tbd) MIME subtypes - (tbd) MIME subtypes
- [IANA character sets](https://www.iana.org/assignments/character-sets/character-sets.xhtml) - [IANA character sets](https://www.iana.org/assignments/character-sets/character-sets.xhtml)
## Alternatives ## State of the art / alternatives
`stalwartlab/mail_parser` `stalwartlab/mail_parser`