.. _l-methods:

Methods
=======

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


Summary
+++++++

+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                      | class parent             | truncated documentation                                                                                                    |
+=============================================================================================================+==========================+============================================================================================================================+
| :py:meth:`__del__ <pymmails.helpers.buffer_files_writing.BufferFilesWriting.__del__>`                       | BufferFilesWriting       | destructor, check everything was flushed                                                                                   |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymmails.grabber.mailbox_mock.MailBoxMock.__init__>`                                    | MailBoxMock              |                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymmails.grabber.mailboximap.MailBoxImap.__init__>`                                     | MailBoxImap              |                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymmails.helpers.buffer_files_writing.BufferFilesWriting.__init__>`                     | BufferFilesWriting       | constructor                                                                                                                |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymmails.render.email_message_list_renderer.EmailMessageListRenderer.__init__>`         | EmailMessageListRenderer |                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymmails.render.email_message_renderer.EmailMessageRenderer.__init__>`                  | EmailMessageRenderer     | Defines a template based on `Jinja2 <http://jinja.pocoo.org/docs/dev/>`_.                                                  |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymmails.render.renderer.Renderer.__init__>`                                            | Renderer                 | constructor, defines a template based on `Jinja2 <http://jinja.pocoo.org/docs/dev/>`_                                      |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <pymmails.helpers.buffer_files_writing.BufferFilesWriting.__len__>`                       | BufferFilesWriting       | return the number of buffered files                                                                                        |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__lt__ <pymmails.grabber.email_message.EmailMessage.__lt__>`                                      | EmailMessage             | usual                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__sortkey__ <pymmails.grabber.email_message.EmailMessage.__sortkey__>`                            | EmailMessage             | usual                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`as_bytes <pymmails.grabber.email_message.EmailMessage.as_bytes>`                                     | EmailMessage             | converts the mail into a binary string                                                                                     |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`as_string <pymmails.grabber.email_message.EmailMessage.as_string>`                                   | EmailMessage             | Converts the mail into a string.                                                                                           |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`decode_header <pymmails.grabber.email_message.EmailMessage.decode_header>`                           | EmailMessage             | decode a string encoded in the header                                                                                      |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`default_filename <pymmails.grabber.email_message.EmailMessage.default_filename>`                     | EmailMessage             | define a default filename (no extension)                                                                                   |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`dump <pymmails.grabber.email_message.EmailMessage.dump>`                                             | EmailMessage             | Dumps a message using a call such as :class:`EmailMessageRenderer`.                                                        |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`dump_attachments <pymmails.grabber.email_message.EmailMessage.dump_attachments>`                     | EmailMessage             | Dumps the mail into a folder using HTML format. If the destination files already exists, it skips it. If ...               |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_attachments <pymmails.grabber.email_message.EmailMessage.enumerate_attachments>`           | EmailMessage             | enumerate the attachments as 4-uple (filename, content, message_id, content_id)                                            |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_mails_in_folder <pymmails.grabber.mailbox_mock.MailBoxMock.enumerate_mails_in_folder>`     | MailBoxMock              | enumerate all mails in a folder                                                                                            |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_mails_in_folder <pymmails.grabber.mailboximap.MailBoxImap.enumerate_mails_in_folder>`      | MailBoxImap              | Enumerates all mails in folder folder.                                                                                     |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_search_person <pymmails.grabber.mailbox_mock.MailBoxMock.enumerate_search_person>`         | MailBoxMock              | enumerates all mails in folder folder from a user or sent to a user                                                        |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_search_person <pymmails.grabber.mailboximap.MailBoxImap.enumerate_search_person>`          | MailBoxImap              | Enumerates all mails in folder folder from a user or sent to a user.                                                       |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_search_subject <pymmails.grabber.mailbox_mock.MailBoxMock.enumerate_search_subject>`       | MailBoxMock              | enumerates all mails in folder folder with a subject verifying a regular expression                                        |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_search_subject <pymmails.grabber.mailboximap.MailBoxImap.enumerate_search_subject>`        | MailBoxImap              | Enumerates all mails in folder folder with a subject verifying a regular expression.                                       |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`exists <pymmails.helpers.buffer_files_writing.BufferFilesWriting.exists>`                            | BufferFilesWriting       | tells if a file was already written                                                                                        |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`flush <pymmails.helpers.buffer_files_writing.BufferFilesWriting.flush>`                              | BufferFilesWriting       | flush a file (actually write it) and make it disappear from the list of buffered files, if the folder does not exists, ... |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`flush <pymmails.render.renderer.Renderer.flush>`                                                     | Renderer                 | flushes all files                                                                                                          |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`folders <pymmails.grabber.mailbox_mock.MailBoxMock.folders>`                                         | MailBoxMock              | returns the list of folder of the mail box                                                                                 |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`folders <pymmails.grabber.mailboximap.MailBoxImap.folders>`                                          | MailBoxImap              | Returns the list of folder of the mail box.                                                                                |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_all_charsets <pymmails.grabber.email_message.EmailMessage.get_all_charsets>`                     | EmailMessage             | returns all the charsets                                                                                                   |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_date <pymmails.grabber.email_message.EmailMessage.get_date>`                                     | EmailMessage             | return a datetime object for the field Date                                                                                |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_date_str <pymmails.grabber.email_message.EmailMessage.get_date_str>`                             | EmailMessage             | return the date into a string                                                                                              |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_field <pymmails.grabber.email_message.EmailMessage.get_field>`                                   | EmailMessage             | get a field and cleans it                                                                                                  |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_from <pymmails.grabber.email_message.EmailMessage.get_from>`                                     | EmailMessage             | returns a tuple (label, email address) or a list of groups from the regular expression                                     |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_from_str <pymmails.grabber.email_message.EmailMessage.get_from_str>`                             | EmailMessage             | return a string for the receivers                                                                                          |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_name <pymmails.grabber.email_message.EmailMessage.get_name>`                                     | EmailMessage             | return the sender name of an email (if available)                                                                          |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_nb_attachements <pymmails.grabber.email_message.EmailMessage.get_nb_attachements>`               | EmailMessage             | return the number of attachments                                                                                           |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_to <pymmails.grabber.email_message.EmailMessage.get_to>`                                         | EmailMessage             | return the receivers                                                                                                       |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_to_str <pymmails.grabber.email_message.EmailMessage.get_to_str>`                                 | EmailMessage             | return a string for the receivers                                                                                          |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`listfiles <pymmails.helpers.buffer_files_writing.BufferFilesWriting.listfiles>`                      | BufferFilesWriting       | returns the list of flushed and opened files, does not preserved order                                                     |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`login <pymmails.grabber.mailbox_mock.MailBoxMock.login>`                                             | MailBoxMock              | login (nothing to do here)                                                                                                 |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`login <pymmails.grabber.mailboximap.MailBoxImap.login>`                                              | MailBoxImap              | login                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`logout <pymmails.grabber.mailbox_mock.MailBoxMock.logout>`                                           | MailBoxMock              | logout (nothing to do here)                                                                                                |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`logout <pymmails.grabber.mailboximap.MailBoxImap.logout>`                                            | MailBoxImap              | logout                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`open <pymmails.helpers.buffer_files_writing.BufferFilesWriting.open>`                                | BufferFilesWriting       | open a file and returns a buffer                                                                                           |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`process_body_html <pymmails.render.email_message_renderer.EmailMessageRenderer.process_body_html>`   | EmailMessageRenderer     | replaces link to images included in the mail body                                                                          |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`produce_table_html <pymmails.render.email_message_renderer.EmailMessageRenderer.produce_table_html>` | EmailMessageRenderer     | produces a table with the values of some fields of the message                                                             |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_binary_content <pymmails.helpers.buffer_files_writing.BufferFilesWriting.read_binary_content>`  | BufferFilesWriting       | return the content of file (binary format)                                                                                 |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_mail_from_file <pymmails.grabber.mailbox_mock.MailBoxMock.read_mail_from_file>`                 | MailBoxMock              | extract a mail from a file                                                                                                 |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`render <pymmails.render.email_message_list_renderer.EmailMessageListRenderer.render>`                | EmailMessageListRenderer | Renders a mail.                                                                                                            |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`render <pymmails.render.email_message_renderer.EmailMessageRenderer.render>`                         | EmailMessageRenderer     | Renders a mail.                                                                                                            |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`render <pymmails.render.renderer.Renderer.render>`                                                   | Renderer                 | render a mail                                                                                                              |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`to_dict <pymmails.grabber.email_message.EmailMessage.to_dict>`                                       | EmailMessage             | Returns all fields for an emails as a dictionary                                                                           |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`write <pymmails.render.email_message_list_renderer.EmailMessageListRenderer.write>`                  | EmailMessageListRenderer | Writes a list of mails in a folder and writes a summary.                                                                   |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`write <pymmails.render.email_message_renderer.EmailMessageRenderer.write>`                           | EmailMessageRenderer     | Writes a mail, the function assumes the attachments were already dumped.                                                   |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`write <pymmails.render.renderer.Renderer.write>`                                                     | Renderer                 | writes a mail, the function assumes the attachments were already dumped                                                    |
+-------------------------------------------------------------------------------------------------------------+--------------------------+----------------------------------------------------------------------------------------------------------------------------+