summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3d361a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+
+# mail
+
+This repository contains the rust mail crates.
+
+They provides ways to represent, generate and
+send mails.
+
+The generation can be done with custom code or
+using a template library. Bindings for `handlebars`
+are included but binding other libraries isn't
+hard either.
+
+The sending is done over `SMTP` it is currently
+focused on sending the mails to a
+Message Submission Agent (MSA) through it could
+be used in other contexts, too.
+
+Currently there is no mail parsing implemented.
+
+The readme of the `mail` crate which acts as
+a facade exposing all this features can be
+fund under [`mail/README.md`](mail/README.md) \ No newline at end of file