.. _l-modules:

Modules
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| module                                                          | truncated documentation                                                                                                            |
+=================================================================+====================================================================================================================================+
| :ref:`__init__ <f-init>`                                        | module ``pymmails``    Module *pymmails*.  Functions to automatically grab and send mails.      :githublink:`%|py|7`               |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                                       | module ``pymmails.grabber``    Shortcuts to grabber      :githublink:`%|py|5`                                                      |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                                      | module ``pymmails.helpers``    Shortcuts to helpers      :githublink:`%|py|5`                                                      |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                                     | module ``pymmails.render``    Shortcuts to render      :githublink:`%|py|5`                                                        |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzz>`                                    | module ``pymmails.sender``    Shortcuts to sender      :githublink:`%|py|5`                                                        |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`additional_mime_type <f-additionalmimetype>`              | module ``pymmails.grabber.additional_mime_type``    additional mapping between mime types and extensions      :githublink:`%|py|5` |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`buffer_files_writing <f-bufferfileswriting>`              | module ``pymmails.helpers.buffer_files_writing``    Buffer files writing      :githublink:`%|py|5`                                 |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`email_message <f-emailmessage>`                           | module ``pymmails.grabber.email_message``    define an Email grabbed from a server.      :githublink:`%|py|6`                      |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`email_message_list_renderer <f-emailmessagelistrenderer>` | module ``pymmails.render.email_message_list_renderer``    Functions to dump emails      :githublink:`%|py|0`                       |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`email_message_renderer <f-emailmessagerenderer>`          | module ``pymmails.render.email_message_renderer``    Functions to dump emails      :githublink:`%|py|0`                            |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`email_message_style <f-emailmessagestyle>`                | module ``pymmails.render.email_message_style``    HTML style to display an Email      :githublink:`%|py|5`                         |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`email_sender <f-emailsender>`                             | module ``pymmails.sender.email_sender``    Functions to send emails      :githublink:`%|py|5`                                      |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`helpers_exceptions <f-helpersexceptions>`                 | module ``pymmails.helpers.helpers_exceptions``    Exception for subfolders ``helpers``      :githublink:`%|py|5`                   |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`iter_helper <f-iterhelper>`                               | module ``pymmails.helpers.iter_helper``    Helpers with iterator      :githublink:`%|py|5`                                         |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`mail_exception <f-mailexception>`                         | module ``pymmails.grabber.mail_exception``    Exception      :githublink:`%|py|5`                                                  |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`mailbox_mock <f-mailboxmock>`                             | module ``pymmails.grabber.mailbox_mock``    Defines a mailbox using IMAP      :githublink:`%|py|5`                                 |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`mailboximap <f-mailboximap>`                              | module ``pymmails.grabber.mailboximap``    Defines a mailbox using IMAP      :githublink:`%|py|5`                                  |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`pop_helper <f-pophelper>`                                 | module ``pymmails.grabber.pop_helper``    Helper around POP server      :githublink:`%|py|5`                                       |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`renderer <f-renderer>`                                    | module ``pymmails.render.renderer``    Functions to dump emails      :githublink:`%|py|0`                                          |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`renderer_exceptions <f-rendererexceptions>`               | module ``pymmails.render.renderer_exceptions``    Exceptions.      :githublink:`%|py|5`                                            |
+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    pymmails/__init__
    pymmails/grabber/__init__
    pymmails/grabber/additional_mime_type
    pymmails/grabber/email_message
    pymmails/grabber/mail_exception
    pymmails/grabber/mailbox_mock
    pymmails/grabber/mailboximap
    pymmails/grabber/pop_helper
    pymmails/helpers/__init__
    pymmails/helpers/buffer_files_writing
    pymmails/helpers/helpers_exceptions
    pymmails/helpers/iter_helper
    pymmails/render/__init__
    pymmails/render/email_message_list_renderer
    pymmails/render/email_message_renderer
    pymmails/render/email_message_style
    pymmails/render/renderer
    pymmails/render/renderer_exceptions
    pymmails/sender/__init__
    pymmails/sender/email_sender