parseur.mailbox

Classes

MailboxOrderKey	Enumeration of supported mailbox sorting keys.
Mailbox

Module Contents

class parseur.mailbox.MailboxOrderKey

Bases: str, enum.Enum

Enumeration of supported mailbox sorting keys.

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

NAME = 'name'

DOCUMENT_COUNT = 'document_count'

TEMPLATE_COUNT = 'template_count'

PARSEDOK_COUNT = 'PARSEDOK_count'

PARSEDKO_COUNT = 'PARSEDKO_count'

QUOTAEXC_COUNT = 'QUOTAEXC_count'

EXPORTKO_COUNT = 'EXPORTKO_count'

class parseur.mailbox.Mailbox

classmethod from_response(data: Dict) → Dict

Deserialize a single mailbox API response.

Parameters:

data – Raw API response dictionary.

Returns:

Validated and transformed mailbox dictionary.

classmethod iter(*, search: str | None = None, order_by: MailboxOrderKey | None = None, ascending: bool = True) → Iterable[Dict]

Yield all mailboxes with pagination and optional filtering or sorting.

classmethod list(*, search: str | None = None, order_by: MailboxOrderKey | None = None, ascending: bool = True) → List[Dict[str, Any]]

Retrieve all mailboxes as a list.

classmethod retrieve(mailbox_id: int) → Dict[str, Any]

Retrieve a single mailbox by ID.

classmethod schema(mailbox_id: int) → Dict[str, Any]

Get the schema for a mailbox.