summaryrefslogtreecommitdiff
path: root/mail/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'mail/docs/api')
-rw-r--r--mail/docs/api/Makefile177
-rw-r--r--mail/docs/api/conf.py331
-rw-r--r--mail/docs/api/index.rst23
-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/mail.imap.rst118
-rw-r--r--mail/docs/api/mail.imap.service.rst30
-rw-r--r--mail/docs/api/mail.imap.tests.rst38
-rw-r--r--mail/docs/api/mail.rst70
-rw-r--r--mail/docs/api/mail.smtp.rst37
-rw-r--r--mail/docs/api/mail.smtp.tests.rst22
-rw-r--r--mail/docs/api/make.bat242
19 files changed, 317 insertions, 1088 deletions
diff --git a/mail/docs/api/Makefile b/mail/docs/api/Makefile
deleted file mode 100644
index ebcd0f47..00000000
--- a/mail/docs/api/Makefile
+++ /dev/null
@@ -1,177 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
-
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " texinfo to make Texinfo files"
- @echo " info to make Texinfo files and run them through makeinfo"
- @echo " gettext to make PO message catalogs"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " xml to make Docutils-native XML files"
- @echo " pseudoxml to make pseudoxml-XML files for display purposes"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-clean:
- rm -rf $(BUILDDIR)/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/mail.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/mail.qhc"
-
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/mail"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/mail"
- @echo "# devhelp"
-
-epub:
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-latexpdfja:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through platex and dvipdfmx..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
- @echo
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo
- @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
- @echo "Run \`make' in that directory to run these through makeinfo" \
- "(use \`make info' here to do that automatically)."
-
-info:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo "Running Texinfo files through makeinfo..."
- make -C $(BUILDDIR)/texinfo info
- @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
- @echo
- @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
-
-xml:
- $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
- @echo
- @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
- $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
- @echo
- @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/mail/docs/api/conf.py b/mail/docs/api/conf.py
deleted file mode 100644
index 2199c2f6..00000000
--- a/mail/docs/api/conf.py
+++ /dev/null
@@ -1,331 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# mail documentation build configuration file, created by
-# sphinx-quickstart on Mon Aug 25 19:47:12 2014.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys
-import os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
- 'sphinx.ext.autodoc',
- 'sphinx.ext.viewcode',
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'mail'
-copyright = u'2014, Author'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = ''
-# The full version, including alpha/beta/rc tags.
-release = ''
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'maildoc'
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- ('index', 'mail.tex', u'mail Documentation',
- u'Author', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', 'mail', u'mail Documentation',
- [u'Author'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', 'mail', u'mail Documentation',
- u'Author', 'mail', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
-
-
-# -- Options for Epub output ----------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = u'mail'
-epub_author = u'Author'
-epub_publisher = u'Author'
-epub_copyright = u'2014, Author'
-
-# The basename for the epub file. It defaults to the project name.
-#epub_basename = u'mail'
-
-# The HTML theme for the epub output. Since the default themes are not optimized
-# for small screen space, using the same theme for HTML and epub output is
-# usually not wise. This defaults to 'epub', a theme designed to save visual
-# space.
-#epub_theme = 'epub'
-
-# The language of the text. It defaults to the language option
-# or en if the language is not set.
-#epub_language = ''
-
-# The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#epub_identifier = ''
-
-# A unique identification for the text.
-#epub_uid = ''
-
-# A tuple containing the cover image and cover page html template filenames.
-#epub_cover = ()
-
-# A sequence of (type, uri, title) tuples for the guide element of content.opf.
-#epub_guide = ()
-
-# HTML files that should be inserted before the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_pre_files = []
-
-# HTML files shat should be inserted after the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_post_files = []
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
-
-# The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
-
-# Allow duplicate toc entries.
-#epub_tocdup = True
-
-# Choose between 'default' and 'includehidden'.
-#epub_tocscope = 'default'
-
-# Fix unsupported image types using the PIL.
-#epub_fix_images = False
-
-# Scale large images.
-#epub_max_image_width = 0
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#epub_show_urls = 'inline'
-
-# If false, no index is generated.
-#epub_use_index = True
diff --git a/mail/docs/api/index.rst b/mail/docs/api/index.rst
deleted file mode 100644
index f5531df6..00000000
--- a/mail/docs/api/index.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-.. mail documentation master file, created by
- sphinx-quickstart on Mon Aug 25 19:47:12 2014.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to mail's documentation!
-================================
-
-Contents:
-
-.. toctree::
- :maxdepth: 4
-
- mail
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
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/mail.imap.rst b/mail/docs/api/mail.imap.rst
deleted file mode 100644
index 051ded63..00000000
--- a/mail/docs/api/mail.imap.rst
+++ /dev/null
@@ -1,118 +0,0 @@
-mail.imap package
-=================
-
-Subpackages
------------
-
-.. toctree::
-
- mail.imap.service
- mail.imap.tests
-
-Submodules
-----------
-
-mail.imap.account module
-------------------------
-
-.. automodule:: mail.imap.account
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.fetch module
-----------------------
-
-.. automodule:: mail.imap.fetch
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.fields module
------------------------
-
-.. automodule:: mail.imap.fields
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.index module
-----------------------
-
-.. automodule:: mail.imap.index
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.interfaces module
----------------------------
-
-.. automodule:: mail.imap.interfaces
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.mailbox module
-------------------------
-
-.. automodule:: mail.imap.mailbox
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.memorystore module
-----------------------------
-
-.. automodule:: mail.imap.memorystore
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.messageparts module
------------------------------
-
-.. automodule:: mail.imap.messageparts
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.messages module
--------------------------
-
-.. automodule:: mail.imap.messages
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.parser module
------------------------
-
-.. automodule:: mail.imap.parser
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.server module
------------------------
-
-.. automodule:: mail.imap.server
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.soledadstore module
------------------------------
-
-.. automodule:: mail.imap.soledadstore
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: mail.imap
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/mail/docs/api/mail.imap.service.rst b/mail/docs/api/mail.imap.service.rst
deleted file mode 100644
index c288813a..00000000
--- a/mail/docs/api/mail.imap.service.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-mail.imap.service package
-=========================
-
-Submodules
-----------
-
-mail.imap.service.imap module
------------------------------
-
-.. automodule:: mail.imap.service.imap
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.service.manhole module
---------------------------------
-
-.. automodule:: mail.imap.service.manhole
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: mail.imap.service
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/mail/docs/api/mail.imap.tests.rst b/mail/docs/api/mail.imap.tests.rst
deleted file mode 100644
index b6717a33..00000000
--- a/mail/docs/api/mail.imap.tests.rst
+++ /dev/null
@@ -1,38 +0,0 @@
-mail.imap.tests package
-=======================
-
-Submodules
-----------
-
-mail.imap.tests.imapclient module
----------------------------------
-
-.. automodule:: mail.imap.tests.imapclient
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.tests.test_imap module
---------------------------------
-
-.. automodule:: mail.imap.tests.test_imap
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.imap.tests.walktree module
--------------------------------
-
-.. automodule:: mail.imap.tests.walktree
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: mail.imap.tests
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/mail/docs/api/mail.rst b/mail/docs/api/mail.rst
deleted file mode 100644
index 27132078..00000000
--- a/mail/docs/api/mail.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-mail package
-============
-
-Subpackages
------------
-
-.. toctree::
-
- mail.imap
- mail.smtp
-
-Submodules
-----------
-
-mail.decorators module
-----------------------
-
-.. automodule:: mail.decorators
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.load_tests module
-----------------------
-
-.. automodule:: mail.load_tests
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.messageflow module
------------------------
-
-.. automodule:: mail.messageflow
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.size module
-----------------
-
-.. automodule:: mail.size
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.utils module
------------------
-
-.. automodule:: mail.utils
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.walk module
-----------------
-
-.. automodule:: mail.walk
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: mail
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/mail/docs/api/mail.smtp.rst b/mail/docs/api/mail.smtp.rst
deleted file mode 100644
index da67279b..00000000
--- a/mail/docs/api/mail.smtp.rst
+++ /dev/null
@@ -1,37 +0,0 @@
-mail.smtp package
-=================
-
-Subpackages
------------
-
-.. toctree::
-
- mail.smtp.tests
-
-Submodules
-----------
-
-mail.smtp.gateway module
-------------------------
-
-.. automodule:: mail.smtp.gateway
- :members:
- :undoc-members:
- :show-inheritance:
-
-mail.smtp.rfc3156 module
-------------------------
-
-.. automodule:: mail.smtp.rfc3156
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: mail.smtp
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/mail/docs/api/mail.smtp.tests.rst b/mail/docs/api/mail.smtp.tests.rst
deleted file mode 100644
index c313fb36..00000000
--- a/mail/docs/api/mail.smtp.tests.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-mail.smtp.tests package
-=======================
-
-Submodules
-----------
-
-mail.smtp.tests.test_gateway module
------------------------------------
-
-.. automodule:: mail.smtp.tests.test_gateway
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: mail.smtp.tests
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/mail/docs/api/make.bat b/mail/docs/api/make.bat
deleted file mode 100644
index 63cd17f9..00000000
--- a/mail/docs/api/make.bat
+++ /dev/null
@@ -1,242 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
- set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
-set I18NSPHINXOPTS=%SPHINXOPTS% .
-if NOT "%PAPER%" == "" (
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
- set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
- :help
- echo.Please use `make ^<target^>` where ^<target^> is one of
- echo. html to make standalone HTML files
- echo. dirhtml to make HTML files named index.html in directories
- echo. singlehtml to make a single large HTML file
- echo. pickle to make pickle files
- echo. json to make JSON files
- echo. htmlhelp to make HTML files and a HTML help project
- echo. qthelp to make HTML files and a qthelp project
- echo. devhelp to make HTML files and a Devhelp project
- echo. epub to make an epub
- echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
- echo. text to make text files
- echo. man to make manual pages
- echo. texinfo to make Texinfo files
- echo. gettext to make PO message catalogs
- echo. changes to make an overview over all changed/added/deprecated items
- echo. xml to make Docutils-native XML files
- echo. pseudoxml to make pseudoxml-XML files for display purposes
- echo. linkcheck to check all external links for integrity
- echo. doctest to run all doctests embedded in the documentation if enabled
- goto end
-)
-
-if "%1" == "clean" (
- for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
- del /q /s %BUILDDIR%\*
- goto end
-)
-
-
-%SPHINXBUILD% 2> nul
-if errorlevel 9009 (
- echo.
- echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
- echo.installed, then set the SPHINXBUILD environment variable to point
- echo.to the full path of the 'sphinx-build' executable. Alternatively you
- echo.may add the Sphinx directory to PATH.
- echo.
- echo.If you don't have Sphinx installed, grab it from
- echo.http://sphinx-doc.org/
- exit /b 1
-)
-
-if "%1" == "html" (
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/html.
- goto end
-)
-
-if "%1" == "dirhtml" (
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
- goto end
-)
-
-if "%1" == "singlehtml" (
- %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
- goto end
-)
-
-if "%1" == "pickle" (
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can process the pickle files.
- goto end
-)
-
-if "%1" == "json" (
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can process the JSON files.
- goto end
-)
-
-if "%1" == "htmlhelp" (
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
- goto end
-)
-
-if "%1" == "qthelp" (
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\mail.qhcp
- echo.To view the help file:
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\mail.ghc
- goto end
-)
-
-if "%1" == "devhelp" (
- %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished.
- goto end
-)
-
-if "%1" == "epub" (
- %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The epub file is in %BUILDDIR%/epub.
- goto end
-)
-
-if "%1" == "latex" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
- goto end
-)
-
-if "%1" == "latexpdf" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
- cd %BUILDDIR%/latex
- make all-pdf
- cd %BUILDDIR%/..
- echo.
- echo.Build finished; the PDF files are in %BUILDDIR%/latex.
- goto end
-)
-
-if "%1" == "latexpdfja" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
- cd %BUILDDIR%/latex
- make all-pdf-ja
- cd %BUILDDIR%/..
- echo.
- echo.Build finished; the PDF files are in %BUILDDIR%/latex.
- goto end
-)
-
-if "%1" == "text" (
- %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The text files are in %BUILDDIR%/text.
- goto end
-)
-
-if "%1" == "man" (
- %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The manual pages are in %BUILDDIR%/man.
- goto end
-)
-
-if "%1" == "texinfo" (
- %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
- goto end
-)
-
-if "%1" == "gettext" (
- %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
- goto end
-)
-
-if "%1" == "changes" (
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
- if errorlevel 1 exit /b 1
- echo.
- echo.The overview file is in %BUILDDIR%/changes.
- goto end
-)
-
-if "%1" == "linkcheck" (
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
- if errorlevel 1 exit /b 1
- echo.
- echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
- goto end
-)
-
-if "%1" == "doctest" (
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
- if errorlevel 1 exit /b 1
- echo.
- echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
- goto end
-)
-
-if "%1" == "xml" (
- %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The XML files are in %BUILDDIR%/xml.
- goto end
-)
-
-if "%1" == "pseudoxml" (
- %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
- goto end
-)
-
-:end