.. _l-classes:

Classes
=======

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


Summary
+++++++

+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                    | class parent | truncated documentation                                                                                                      |
+==========================================================================================================+==============+==============================================================================================================================+
| :class:`BufferFilesWriting <pymmails.helpers.buffer_files_writing.BufferFilesWriting>`                   |              | this class aims at delaying writing files, method *open* returns a buffer, method *flush* actually writes the file ...       |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`EmailMessage <pymmails.grabber.email_message.EmailMessage>`                                      |              | overloads the message to class to add some functionalities such as a display using HTML                                      |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`EmailMessageListRenderer <pymmails.render.email_message_list_renderer.EmailMessageListRenderer>` |              | Defines a way to render a list of emails with a template template based on `Jinja2 <http://jinja.pocoo.org/docs/dev/>`_. ... |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`EmailMessageRenderer <pymmails.render.email_message_renderer.EmailMessageRenderer>`              |              | defines way to render an email                                                                                               |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`FileAlreadyExistingException <pymmails.helpers.helpers_exceptions.FileAlreadyExistingException>` |              | file which already existing                                                                                                  |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`FileNotFlushedException <pymmails.helpers.helpers_exceptions.FileNotFlushedException>`           |              | raised when the class :class:`BufferFilesWriting` still contains some files not flushed when deleted                         |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`MailBoxImap <pymmails.grabber.mailboximap.MailBoxImap>`                                          |              | Defines a mail box with :epkg:`IMAP` interface.                                                                              |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`MailBoxMock <pymmails.grabber.mailbox_mock.MailBoxMock>`                                         |              | Define a mail box reading from file (kind of mock).                                                                          |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`MailException <pymmails.grabber.mail_exception.MailException>`                                   |              | custom exception for all class and functions below                                                                           |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`RenderException <pymmails.render.renderer_exceptions.RenderException>`                           |              | Custom exception for all class and functions below.                                                                          |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+
| :class:`Renderer <pymmails.render.renderer.Renderer>`                                                    |              | defines way to render an email                                                                                               |
+----------------------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------+