summaryrefslogtreecommitdiff
path: root/mail/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'mail/docs/api')
-rw-r--r--mail/docs/api/leap.mail.adaptors.rst43
-rw-r--r--mail/docs/api/leap.mail.adaptors.tests.rst28
-rw-r--r--mail/docs/api/leap.mail.imap.rst52
-rw-r--r--mail/docs/api/leap.mail.imap.service.rst9
-rw-r--r--mail/docs/api/leap.mail.incoming.rst20
-rw-r--r--mail/docs/api/leap.mail.outgoing.rst21
-rw-r--r--mail/docs/api/leap.mail.plugins.rst20
-rw-r--r--mail/docs/api/leap.mail.rst105
-rw-r--r--mail/docs/api/leap.mail.smtp.rst19
-rw-r--r--mail/docs/api/modules.rst7
10 files changed, 324 insertions, 0 deletions
diff --git a/mail/docs/api/leap.mail.adaptors.rst b/mail/docs/api/leap.mail.adaptors.rst
new file mode 100644
index 00000000..472cadef
--- /dev/null
+++ b/mail/docs/api/leap.mail.adaptors.rst
@@ -0,0 +1,43 @@
+mail.adaptors package
+=====================
+
+.. automodule:: leap.mail.adaptors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ leap.mail.adaptors.tests
+
+Submodules
+----------
+
+mail.adaptors.models module
+---------------------------
+
+.. automodule:: leap.mail.adaptors.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+mail.adaptors.soledad module
+----------------------------
+
+.. automodule:: leap.mail.adaptors.soledad
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+mail.adaptors.soledad_indexes module
+------------------------------------
+
+.. automodule:: leap.mail.adaptors.soledad_indexes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
diff --git a/mail/docs/api/leap.mail.adaptors.tests.rst b/mail/docs/api/leap.mail.adaptors.tests.rst
new file mode 100644
index 00000000..2ae76e8a
--- /dev/null
+++ b/mail/docs/api/leap.mail.adaptors.tests.rst
@@ -0,0 +1,28 @@
+mail.adaptors.tests package
+===========================
+
+.. automodule:: leap.mail.adaptors.tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+mail.adaptors.tests.test_models module
+--------------------------------------
+
+.. automodule:: leap.mail.adaptors.tests.test_models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+mail.adaptors.tests.test_soledad_adaptor module
+-----------------------------------------------
+
+.. automodule:: leap.mail.adaptors.tests.test_soledad_adaptor
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
diff --git a/mail/docs/api/leap.mail.imap.rst b/mail/docs/api/leap.mail.imap.rst
new file mode 100644
index 00000000..bfaa3fd7
--- /dev/null
+++ b/mail/docs/api/leap.mail.imap.rst
@@ -0,0 +1,52 @@
+leap.mail.imap package
+=======================
+
+.. automodule:: leap.mail.imap
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ leap.mail.imap.service
+ leap.mail.imap.tests
+
+Submodules
+----------
+
+leap.mail.imap.account module
+------------------------------
+
+.. automodule:: leap.mail.imap.account
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.imap.mailbox module
+------------------------------
+
+.. automodule:: leap.mail.imap.mailbox
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.imap.messages module
+------------------------------
+
+.. automodule:: leap.mail.imap.messages
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.imap.server module
+-----------------------------
+
+.. automodule:: leap.mail.imap.server
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
diff --git a/mail/docs/api/leap.mail.imap.service.rst b/mail/docs/api/leap.mail.imap.service.rst
new file mode 100644
index 00000000..2f3ed4bb
--- /dev/null
+++ b/mail/docs/api/leap.mail.imap.service.rst
@@ -0,0 +1,9 @@
+leap.mail.imap.service package
+===============================
+
+.. automodule:: leap.mail.imap.service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
diff --git a/mail/docs/api/leap.mail.incoming.rst b/mail/docs/api/leap.mail.incoming.rst
new file mode 100644
index 00000000..4bd16141
--- /dev/null
+++ b/mail/docs/api/leap.mail.incoming.rst
@@ -0,0 +1,20 @@
+leap.mail.incoming package
+==========================
+
+.. automodule:: leap.mail.incoming
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+leap.mail.incoming.service module
+----------------------------------
+
+.. automodule:: leap.mail.incoming.service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
diff --git a/mail/docs/api/leap.mail.outgoing.rst b/mail/docs/api/leap.mail.outgoing.rst
new file mode 100644
index 00000000..af8c1734
--- /dev/null
+++ b/mail/docs/api/leap.mail.outgoing.rst
@@ -0,0 +1,21 @@
+leap.mail.outgoing package
+==========================
+
+.. automodule:: leap.mail.outgoing
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Submodules
+----------
+
+mail.outgoing.service module
+----------------------------
+
+.. automodule:: leap.mail.outgoing.service
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
diff --git a/mail/docs/api/leap.mail.plugins.rst b/mail/docs/api/leap.mail.plugins.rst
new file mode 100644
index 00000000..7a5d6b4d
--- /dev/null
+++ b/mail/docs/api/leap.mail.plugins.rst
@@ -0,0 +1,20 @@
+leap.mail.plugins package
+==========================
+
+.. automodule:: leap.mail.plugins
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+leap.mail.plugins.soledad_sync_hooks module
+-------------------------------------------
+
+.. automodule:: leap.mail.plugins.soledad_sync_hooks
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
diff --git a/mail/docs/api/leap.mail.rst b/mail/docs/api/leap.mail.rst
new file mode 100644
index 00000000..686e648e
--- /dev/null
+++ b/mail/docs/api/leap.mail.rst
@@ -0,0 +1,105 @@
+leap.mail package
+=================
+
+.. automodule:: leap.mail
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ leap.mail.adaptors
+ leap.mail.imap
+ leap.mail.incoming
+ leap.mail.outgoing
+ leap.mail.plugins
+ leap.mail.smtp
+ leap.mail.tests
+
+Submodules
+----------
+
+leap.mail.constants module
+---------------------------
+
+.. automodule:: leap.mail.constants
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.decorators module
+---------------------------
+
+.. automodule:: leap.mail.decorators
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.interfaces module
+----------------------------
+
+.. automodule:: leap.mail.interfaces
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.load_tests module
+----------------------------
+
+.. automodule:: leap.mail.load_tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.mail module
+---------------------
+
+.. automodule:: leap.mail.mail
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.mailbox_indexer module
+---------------------------------
+
+.. automodule:: leap.mail.mailbox_indexer
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.size module
+----------------------
+
+.. automodule:: leap.mail.size
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.sync_hooks module
+----------------------------
+
+.. automodule:: leap.mail.sync_hooks
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.utils module
+-----------------------
+
+.. automodule:: leap.mail.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+leap.mail.walk module
+----------------------
+
+.. automodule:: leap.mail.walk
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
diff --git a/mail/docs/api/leap.mail.smtp.rst b/mail/docs/api/leap.mail.smtp.rst
new file mode 100644
index 00000000..f35d3f9d
--- /dev/null
+++ b/mail/docs/api/leap.mail.smtp.rst
@@ -0,0 +1,19 @@
+leap.mail.smtp package
+=======================
+
+.. automodule:: leap.mail.smtp
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+leap.mail.smtp.gateway module
+-----------------------------
+
+.. automodule:: leap.mail.smtp.gateway
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/mail/docs/api/modules.rst b/mail/docs/api/modules.rst
new file mode 100644
index 00000000..78277797
--- /dev/null
+++ b/mail/docs/api/modules.rst
@@ -0,0 +1,7 @@
+mail
+====
+
+.. toctree::
+ :maxdepth: 4
+
+ mail