summaryrefslogtreecommitdiff
path: root/src/leap/mail/smtp/README.rst
diff options
context:
space:
mode:
authorTomás Touceda <chiiph@leap.se>2013-11-15 10:14:17 -0300
committerTomás Touceda <chiiph@leap.se>2013-11-15 10:14:17 -0300
commit46ccf635c44aeffb75c95845b8b4cc9ce2b1c4a4 (patch)
tree7cea49baa78064599bdb92ca81917c88ad35267a /src/leap/mail/smtp/README.rst
parente04a13bf4dd57b18d1e627d8dabdb26f5a6531b6 (diff)
parent297dfda10617cb7c30aca11c55771c1d60948c6d (diff)
Merge branch 'release-0.3.7'0.3.7
Diffstat (limited to 'src/leap/mail/smtp/README.rst')
-rw-r--r--src/leap/mail/smtp/README.rst38
1 files changed, 9 insertions, 29 deletions
diff --git a/src/leap/mail/smtp/README.rst b/src/leap/mail/smtp/README.rst
index 2b2a118..f625441 100644
--- a/src/leap/mail/smtp/README.rst
+++ b/src/leap/mail/smtp/README.rst
@@ -1,43 +1,23 @@
-Leap SMTP Relay
-===============
+Leap SMTP Gateway
+=================
Outgoing mail workflow:
* LEAP client runs a thin SMTP proxy on the user's device, bound to
localhost.
- * User's MUA is configured outgoing SMTP to localhost
- * When SMTP proxy receives an email from MUA
+ * User's MUA is configured outgoing SMTP to localhost.
+ * When SMTP proxy receives an email from MUA:
* SMTP proxy queries Key Manager for the user's private key and public
- keys of all recipients
+ keys of all recipients.
* Message is signed by sender and encrypted to recipients.
* If recipient's key is missing, email goes out in cleartext (unless
- user has configured option to send only encrypted email)
- * Finally, message is relayed to provider's SMTP relay
-
-
-Dependencies
-------------
-
-Leap SMTP Relay depends on the following python libraries:
-
- * Twisted 12.3.0 [1]
- * zope.interface 4.0.3 [2]
-
-[1] http://pypi.python.org/pypi/Twisted/12.3.0
-[2] http://pypi.python.org/pypi/zope.interface/4.0.3
-
-
-How to run
-----------
-
-To launch the SMTP relay, run the following command:
-
- twistd -y smtprelay.tac
+ user has configured option to send only encrypted email).
+ * Finally, message is gatewayed to provider's SMTP server.
Running tests
-------------
-Tests are run using Twisted's Trial API, like this:
+Tests are run using Twisted's Trial API, like this::
- trial leap.email.smtp.tests
+ python setup.py test -s leap.mail.gateway.tests