summaryrefslogtreecommitdiff
path: root/mail/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'mail/README.rst')
-rw-r--r--mail/README.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/mail/README.rst b/mail/README.rst
new file mode 100644
index 00000000..f201baa1
--- /dev/null
+++ b/mail/README.rst
@@ -0,0 +1,37 @@
+leap.mail
+=========
+Mail services for the LEAP Client.
+
+.. image:: https://badge.fury.io/py/leap.mail.svg
+ :target: http://badge.fury.io/py/leap.mail
+
+.. image:: https://readthedocs.org/projects/leapmail/badge/?version=latest
+ :target: http://leapmail.readthedocs.org/en/latest/
+ :alt: Documentation Status
+
+More info: https://leap.se
+
+running tests
+-------------
+
+Use trial to run the test suite::
+
+ trial leap.mail
+
+... and all its goodies. To run all imap tests in a loop until some of them
+fails::
+
+ trial -u leap.mail.imap
+
+Read the *trial* manpage for more options .
+
+imap regressions
+----------------
+
+For testing the IMAP server implementation, there are a couple of utilities.
+From the ``leap.mail.imap.tests`` folder, and with an already initialized server
+running::
+
+ ./regressions_mime_struct user@provider pass path_to_samples/
+
+You can find several message samples in the ``leap/mail/tests`` folder.