orionis.mail.functions

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

(source)

Undocumented

Function	`attachment_name`	Validate the visible basename of an attachment.
Function	`freeze_owned`	Snapshot containers without copying arbitrary user objects.
Function	`header_value`	Validate a single unstructured header value.
Function	`media_type`	Validate a bare MIME type without header parameters.
Function	`sanitize_reason`	Remove controls and configured secrets from a transport diagnostic.
Constant	`_HEADER_CONTROLS`	Undocumented
Constant	`_MAX_REASON_LENGTH`	Undocumented
Constant	`_MEDIA_TYPE_PARTS`	Undocumented
Constant	`_TOKEN_CHARS`	Undocumented

def attachment_name(value: str) -> str: (source) ¶

Validate the visible basename of an attachment.

Parameters
value:`str`	Name exposed in the Content-Disposition header.

Returns
`str`	The validated name.

Raises
`MailAttachmentException`	If the name is empty, unsafe, or contains a path.

def freeze_owned(value: object, active: frozenset[int] = frozenset()) -> object: (source) ¶

Snapshot containers without copying arbitrary user objects.

Parameters
value:`object`	A container tree or an opaque context value.
active:`frozenset[int]`	Ancestors used to reject cyclic container structures.

Returns
`object`	Read-only copied containers; opaque values retain identity.

Raises
`MailCompositionException`	If a container cycle prevents an immutable snapshot.

def header_value(value: str, label: str) -> str: (source) ¶

Validate a single unstructured header value.

Parameters
value:`str`	Header text, including an intentionally empty subject.
label:`str`	Public field name used in diagnostics.

Returns
`str`	The unchanged safe value.

Raises
`MailCompositionException`	If the value is not text or contains control characters.

def media_type(value: str) -> str: (source) ¶

Validate a bare MIME type without header parameters.

Parameters
value:`str`	Explicit or storage-provided MIME type.

Returns
`str`	A lowercase type/subtype pair.

Raises
`MailAttachmentException`	If either token is invalid or parameters are present.

def sanitize_reason(value: str | bytes, sensitive: tuple[str, ...] = ()) -> str: (source) ¶

Remove controls and configured secrets from a transport diagnostic.

Parameters
value:`str \| bytes`	Server response, decoded with replacement when needed.
sensitive:`tuple[str, ...]`	Credentials and credential-bearing URL representations to redact.

Returns
`str`	A bounded single-line diagnostic.

Undocumented

Value

frozenset(set(['Cc', 'Cf', 'Cs', 'Zl', 'Zp']))

Undocumented

Value

Undocumented

Value

Undocumented

Value

frozenset((ascii_letters + digits + '!#$%&\'*+-.^_`|~'))