ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

module documentation

Represent one mailbox with an optional Unicode display name.

Function addresses Normalize and stably deduplicate a recipient declaration.
Function one_address Normalize exactly one mailbox and reject ambiguous names.
Constant _HEADERS Headers used by address.
Type Alias Recipients Accepted recipient declaration, re-exported by orionis.mail.types.
def addresses(value: Recipients, name: str | None = None) -> tuple[Address, ...]: (source)

Normalize and stably deduplicate a recipient declaration.

Parameters
value:orionis.mail.types.RecipientsSingle mailbox or a list/tuple of mailboxes.
name:str | NoneOptional name for a single string mailbox only.
Returns
tuple[orionis.mail.entities.Address, ...]Mailboxes in first-declaration order.
Raises
orionis.mail.exceptions.MailCompositionExceptionIf a collection is combined with a display name or has invalid entries.
def one_address(value: str | Address, name: str | None = None) -> Address: (source)

Normalize exactly one mailbox and reject ambiguous names.

Parameters
value:str | orionis.mail.entities.AddressOne mailbox.
name:str | NoneDisplay name, valid only with a string mailbox.
Returns
orionis.mail.entities.AddressValidated immutable address.
Raises
orionis.mail.exceptions.MailCompositionExceptionIf the value is not one address or a name is supplied twice.
_HEADERS = (source)

Headers used by address.

Value
HeaderRegistry()

Accepted recipient declaration, re-exported by orionis.mail.types.

Value
str | Address | list[str | Address] | tuple[str | Address, ...]