.. _f-mailboximap:

module ``grabber.mailboximap``
==============================





.. inheritance-diagram:: pymmails.grabber.mailboximap


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

module ``pymmails.grabber.mailboximap``

Defines a mailbox using IMAP


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------------+-------------------------------------------------+
| class                                                           | truncated documentation                         |
+=================================================================+=================================================+
| :class:`MailBoxImap <pymmails.grabber.mailboximap.MailBoxImap>` | Defines a mail box with :epkg:`IMAP` interface. |
+-----------------------------------------------------------------+-------------------------------------------------+










Methods
+++++++

+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| method                                                                                                 | truncated documentation                                                              |
+========================================================================================================+======================================================================================+
| :py:meth:`__init__ <pymmails.grabber.mailboximap.MailBoxImap.__init__>`                                |                                                                                      |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :meth:`enumerate_mails_in_folder <pymmails.grabber.mailboximap.MailBoxImap.enumerate_mails_in_folder>` | Enumerates all mails in folder folder.                                               |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :meth:`enumerate_search_person <pymmails.grabber.mailboximap.MailBoxImap.enumerate_search_person>`     | Enumerates all mails in folder folder from a user or sent to a user.                 |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :meth:`enumerate_search_subject <pymmails.grabber.mailboximap.MailBoxImap.enumerate_search_subject>`   | Enumerates all mails in folder folder with a subject verifying a regular expression. |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :meth:`folders <pymmails.grabber.mailboximap.MailBoxImap.folders>`                                     | Returns the list of folder of the mail box.                                          |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :meth:`login <pymmails.grabber.mailboximap.MailBoxImap.login>`                                         | login                                                                                |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :meth:`logout <pymmails.grabber.mailboximap.MailBoxImap.logout>`                                       | logout                                                                               |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+


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

.. automodule:: pymmails.grabber.mailboximap
    :members:
    :special-members: __init__
    :show-inheritance: