.. _l-functions:

Functions
=========

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


Summary
+++++++

+------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------+
| function                                                                     | class parent | truncated documentation                                                                              |
+==============================================================================+==============+======================================================================================================+
| :func:`_setup_hook <pymmails._setup_hook>`                                   |              | does nothing                                                                                         |
+------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------+
| :func:`check <pymmails.check>`                                               |              | Checks the library is working. It raises an exception. If you want to disable the logs:              |
+------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------+
| :func:`compose_email <pymmails.sender.email_sender.compose_email>`           |              | Composes an email as a string.                                                                       |
+------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------+
| :func:`create_smtp_server <pymmails.sender.email_sender.create_smtp_server>` |              | Creates a SMTP server and log into it.                                                               |
+------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------+
| :func:`iterator_prev_next <pymmails.helpers.iter_helper.iterator_prev_next>` |              | iterator on a sequence and returns another iterator with ``previous item, current item, next item``, |
+------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------+
| :func:`retrieve_mails_pop <pymmails.grabber.pop_helper.retrieve_mails_pop>`  |              | retrieves all emails using POP service                                                               |
+------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------+
| :func:`send_email <pymmails.sender.email_sender.send_email>`                 |              | Sends an email as a string.                                                                          |
+------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------+