parseur.mailbox
===============

.. py:module:: parseur.mailbox


Classes
-------

.. autoapisummary::

   parseur.mailbox.MailboxOrderKey
   parseur.mailbox.Mailbox


Module Contents
---------------

.. py:class:: MailboxOrderKey

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Enumeration of supported mailbox sorting keys.

   Used with the `order_by` parameter to specify sorting in Mailbox.list() and Mailbox.iter().


   .. py:attribute:: NAME
      :value: 'name'



   .. py:attribute:: DOCUMENT_COUNT
      :value: 'document_count'



   .. py:attribute:: TEMPLATE_COUNT
      :value: 'template_count'



   .. py:attribute:: PARSEDOK_COUNT
      :value: 'PARSEDOK_count'



   .. py:attribute:: PARSEDKO_COUNT
      :value: 'PARSEDKO_count'



   .. py:attribute:: QUOTAEXC_COUNT
      :value: 'QUOTAEXC_count'



   .. py:attribute:: EXPORTKO_COUNT
      :value: 'EXPORTKO_count'



.. py:class:: Mailbox

   .. py:method:: from_response(data: Dict) -> Dict
      :classmethod:


      Deserialize a single mailbox API response.

      :param data: Raw API response dictionary.
      :return: Validated and transformed mailbox dictionary.



   .. py:method:: iter(*, search: Optional[str] = None, order_by: Optional[MailboxOrderKey] = None, ascending: bool = True) -> Iterable[Dict]
      :classmethod:


      Yield all mailboxes with pagination and optional filtering or sorting.



   .. py:method:: list(*, search: Optional[str] = None, order_by: Optional[MailboxOrderKey] = None, ascending: bool = True) -> List[Dict[str, Any]]
      :classmethod:


      Retrieve all mailboxes as a list.



   .. py:method:: retrieve(mailbox_id: int) -> Dict[str, Any]
      :classmethod:


      Retrieve a single mailbox by ID.



   .. py:method:: schema(mailbox_id: int) -> Dict[str, Any]
      :classmethod:


      Get the schema for a mailbox.