summaryrefslogtreecommitdiff
path: root/mail
diff options
context:
space:
mode:
Diffstat (limited to 'mail')
-rw-r--r--mail/README.rst11
-rw-r--r--mail/docs/hacking.rst19
2 files changed, 30 insertions, 0 deletions
diff --git a/mail/README.rst b/mail/README.rst
index 317389a5..81b4cec9 100644
--- a/mail/README.rst
+++ b/mail/README.rst
@@ -24,3 +24,14 @@ 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.
diff --git a/mail/docs/hacking.rst b/mail/docs/hacking.rst
index d5669e15..6c49c211 100644
--- a/mail/docs/hacking.rst
+++ b/mail/docs/hacking.rst
@@ -161,6 +161,25 @@ If looking for a quick way of inspecting mailboxes, have a look at ``getmail``::
From: Kali <kali@leap.se>
(snip)
+
+IMAP Message Rendering Regressions
+----------------------------------
+
+For testing the IMAP server implementation, there is a litte regressions script
+that needs some manual work from your side.
+
+First of all, you need an already initialized account. Which for now basically
+means you have created a new account with a provider that offers the Encrypted
+Mail Service, using the Bitmask Client wizard. Then you need to log in with that
+account, and let it generate the secrets and sync with the remote for a first
+time. After this you can run the twistd server locally and offline.
+
+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.
Debugging IMAP commands