=========
mailsuite
=========

A Python package for retrieving, parsing, scanning, and sending emails.
It is particularly useful for triaging potential phishing emails.

Features
--------

- Simplified IMAP client

  - Retrieve email from any folder
  - Create new folders
  - Move messages to other folders
  - Delete messages
  - Monitor folders for new messages using the IMAP ``IDLE`` command
  - Always use ``/`` as the folder hierarchy separator, and convert to the
    server's hierarchy separator in the background
  - Always remove folder name characters that conflict with the server's
    hierarchy separators
  - Prepend the namespace to the folder path when required
  - Automatically reconnect when needed
  - Work around quirks in Gmail, Microsoft 365, Exchange, Dovecot, and
    DavMail

- Consistent email parsing

  - SHA256 hashes of attachments
  - Parsed ``Authentication-Results`` and ``DKIM-Signature`` headers
  - Can parse Microsoft Outlook ``.msg`` files if ``msgconvert`` (included in the ``libemail-outlook-message-perl`` Debian/Ubuntu package) is installed

- Simplified email creation and sending

  - Easily add attachments, plain text, and HTML
  - Uses opportunistic encryption (``STARTTLS``) with SMTP by default


Documentation
-------------

.. toctree::

   api


* :ref:`genindex`