.. _f-renderer:

module ``render.renderer``
==========================





.. inheritance-diagram:: pymmails.render.renderer


Short summary
+++++++++++++

module ``pymmails.render.renderer``

Functions to dump emails


:githublink:`%|py|0`




Classes
+++++++

+-------------------------------------------------------+--------------------------------+
| class                                                 | truncated documentation        |
+=======================================================+================================+
| :class:`Renderer <pymmails.render.renderer.Renderer>` | defines way to render an email |
+-------------------------------------------------------+--------------------------------+






Properties
++++++++++

+---------------------------------------------------------------------+--------------------------------+
| property                                                            | truncated documentation        |
+=====================================================================+================================+
| :meth:`BufferWrite <pymmails.render.renderer.Renderer.BufferWrite>` | returns ``self._buffer_write`` |
+---------------------------------------------------------------------+--------------------------------+






Methods
+++++++

+------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| method                                                           | truncated documentation                                                               |
+==================================================================+=======================================================================================+
| :py:meth:`__init__ <pymmails.render.renderer.Renderer.__init__>` | constructor, defines a template based on `Jinja2 <http://jinja.pocoo.org/docs/dev/>`_ |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :meth:`flush <pymmails.render.renderer.Renderer.flush>`          | flushes all files                                                                     |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :meth:`render <pymmails.render.renderer.Renderer.render>`        | render a mail                                                                         |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------+
| :meth:`write <pymmails.render.renderer.Renderer.write>`          | writes a mail, the function assumes the attachments were already dumped               |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pymmails.render.renderer
    :members:
    :special-members: __init__
    :show-inheritance: