Deprecated repo
[leap_mail.git] / README.rst
1 Deprecation Notice
2 ==================
3
4 This code is deprecated, the current version of Bitmask is developed in the `bitmask-dev`_ repo.
5
6 .. _`bitmask-dev`: https://0xacab.org/leap/bitmask-dev
7
8 leap.mail
9 =========
10 Mail services for the LEAP Client.
11
12 .. image:: https://badge.fury.io/py/leap.mail.svg
13     :target: http://badge.fury.io/py/leap.mail
14
15 .. image:: https://readthedocs.org/projects/leapmail/badge/?version=latest
16          :target: http://leapmail.readthedocs.org/en/latest/
17          :alt: Documentation Status
18
19 More info: https://leap.se
20
21 running tests
22 -------------
23
24 Use trial to run the test suite::
25
26   trial leap.mail
27
28 ... and all its goodies. To run all imap tests in a loop until some of them
29 fails::
30
31   trial -u leap.mail.imap
32
33 Read the *trial* manpage for more options .
34
35 imap regressions
36 ----------------
37
38 For testing the IMAP server implementation, there are a couple of utilities.
39 From the ``leap.mail.imap.tests`` folder, and with an already initialized server
40 running::
41
42   ./regressions_mime_struct user@provider pass path_to_samples/
43
44 You can find several message samples in the ``leap/mail/tests`` folder.