orionis.mail.transports.FileTransport

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.

Explore modules View classes

class documentation

class FileTransport(IMailTransport): (source)

Constructor: FileTransport(path)

View In Hierarchy

Publish complete private .eml files atomically without overwriting.

Publication requires hard-link support in the target filesystem, such as NTFS on Windows or a regular local POSIX filesystem; unsupported filesystems fail explicitly. Each worker owns its temporary file and never shares per-message state.

Method	`__init__`	Retain the application-rooted output directory without touching disk.
Method	`_store`	Stage, sync, and link a message without exposing partial final files.
Async Method	`send`	Write and atomically publish one complete message on a worker.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_path`	Undocumented

def __init__(self, path: Path): (source) ¶

Retain the application-rooted output directory without touching disk.

Parameters
path:`Path`	Absolute output directory, already anchored by the factory.

Returns
`None`	Store only transport configuration.

def _store(self, payload: bytes) -> Path: (source) ¶

Stage, sync, and link a message without exposing partial final files.

Parameters
payload:`bytes`	Serialized MIME message.

Returns
`Path`	Absolute uniquely named final file.

Raises
`OSError`	If any filesystem operation fails; existing files stay untouched.

async def send(self, message: PreparedMail, *, mailer: str, driver: str) -> MailResult: (source) ¶

Write and atomically publish one complete message on a worker.

Parameters
message:`PreparedMail`	Complete MIME bytes and intended recipients.
mailer:`str`	Selected configuration name.
driver:`str`	Registered driver name.

Returns
`MailResult`	Stored result with the final path and no SMTP acceptance claims.

Raises
`MailTransportException`	If writing, syncing, or atomic publication fails.

__slots__: tuple[str, ...] = (source) ¶

Undocumented

_path = (source) ¶

Undocumented