payas/gleambox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update README with RFC list

Browse source
This commit is contained in:
Payas Relekar 2024-07-28 17:52:11 +05:30
parent 3b446e3b73
commit 0de1760f8b
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,9 +1,25 @@
# mbox
Read mbox files.
Parse mbox files in [Gleam](https://gleam.run).
WARNING: This library is a personal project to learn Gleam. It is *extremely* incomplete, barely works, highly *un* - optimized, and is NOT guaranteed to work, in present or future. I do intend to make it useable and utilise in another project, but right now, if you use it and it breaks stuff, you get to keep all the pieces. Be warned and prosper.
That said, there are multiple specs pertaining to the Internet Mail format (thanks to collect them in one place, [mrmime](https://github.com/mirage/mrmime)):
- [RFC822](https://tools.ietf.org/html/rfc822): Standard For The Format of ARPA Internet Text Messages
- [RFC2822](https://tools.ietf.org/html/rfc2822): Internet Message Format
- [RFC5321](https://tools.ietf.org/html/rfc5321): Simple Mail Transfer Protocol
- [RFC5322](https://tools.ietf.org/html/rfc5322): Internet Message Format
- [RFC2045](https://tools.ietf.org/html/rfc2045): MIME Part One: Format of Internet Message Bodies
- [RFC2046](https://tools.ietf.org/html/rfc2046): MIME Part Two: Media Types
- [RFC2047](https://tools.ietf.org/html/rfc2047): MIME Part Three: Message-Header Extensions for Non-ASCII Text
- [RFC2049](https://tools.ietf.org/html/rfc2049): MIME Part Five: Conformance Criteria and Examples
- [RFC6532](https://tools.ietf.org/html/rfc6532): Internationalized Email Headers
So far, there is *some* progress with RFC 822, RFC2822 and RFC 4155. Vast majority of the spec of these RFCs and ALL of the rest of RFCs is yet to be implemented.
The codebase is in flux, as I continue to learn Gleam and get a hang of things, so beware before depending on this lib for anything serious. I am, however, open for suggestions on everything in here, so feel free to reach out by creating an issue or PR.
[![Package Version](https://img.shields.io/hexpm/v/gleambox)](https://hex.pm/packages/gleambox)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gleambox/)