Added README.
authorTim Vaughan <tgvaughan@gmail.com>
Sat, 24 Aug 2019 08:33:27 +0000 (10:33 +0200)
committerTim Vaughan <tgvaughan@gmail.com>
Sat, 24 Aug 2019 08:33:27 +0000 (10:33 +0200)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..84f1dee
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+LambdaMail
+----------
+
+This is an _extremely simple_ SMTP server designed specifically for
+running on personal servers with a very small number (~1) users.  It
+is probably best defined in terms of what it does not support:
+
+- It does not (yet?) support TLS connections.
+- It does not allow outbound connections.
+- It does not spawn threads to allow simultaneous inbound connections.
+- It does not respond with honest errors on failed deliveries.
+
+Apart from the lack of TLS, I consider these features.  There's no
+(obvious) way for LambdaMail to become a source of spam, the lack
+of multithreaded operation is a built-in rate limiter (not to mention
+its side effect of making all delivery operations "atomic"), and
+its penchant for just responding "250 OK" to almost everything means
+that it doesn't leak information about users on the system.
+
+LambdaMail is still under active development and, given that it was
+written for a single use case, lacks any documentation.  However
+it's a pretty simple Scheme program, so glancing over the code should
+suffice.
+
+License
+-------
+
+LambdaMail is free software, and is made available under version 3.0
+of the GNU General Public License.  A copy of this license can be found
+in the file named COPYING.