Skip to content

Factory

factory

Email client factory.

Provides factory functions for creating email client instances based on configuration. Supports custom email client registration.

Classes

Functions

register_email_client 

register_email_client(
    backend_name: str, client_class: Type[EmailClient]
) -> None

Register a custom email client backend.

This allows users to add their own email client implementations without modifying the FastAuth library code.

Parameters:

Name Type Description Default
backend_name str

Name to identify this backend (used in settings.email_backend)

 required
client_class Type[EmailClient]

EmailClient subclass to use for this backend

 required
Example

from fastauth.email.factory import register_email_client from fastauth.email.base import EmailClient

class MyCustomEmailClient(EmailClient): ... def send_verification_email(self, *, to: str, token: str) -> None: ... # Custom implementation ... pass

register_email_client("custom", MyCustomEmailClient)

Source code in fastauth/email/factory.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def register_email_client(backend_name: str, client_class: Type[EmailClient]) -> None:
    """Register a custom email client backend.

    This allows users to add their own email client implementations
    without modifying the FastAuth library code.

    Args:
        backend_name: Name to identify this backend (used in settings.email_backend)
        client_class: EmailClient subclass to use for this backend

    Example:
        >>> from fastauth.email.factory import register_email_client
        >>> from fastauth.email.base import EmailClient
        >>>
        >>> class MyCustomEmailClient(EmailClient):
        ...     def send_verification_email(self, *, to: str, token: str) -> None:
        ...         # Custom implementation
        ...         pass
        >>>
        >>> register_email_client("custom", MyCustomEmailClient)
    """
    _email_client_registry[backend_name] = client_class

get_email_client 

get_email_client() -> EmailClient

Get email client based on settings.email_backend.

Returns:

Type Description
EmailClient

An instance of the configured email client.

Raises:

Type Description
RuntimeError

If the configured backend is not registered.
Source code in fastauth/email/factory.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def get_email_client() -> EmailClient:
    """Get email client based on settings.email_backend.

    Returns:
        An instance of the configured email client.

    Raises:
        RuntimeError: If the configured backend is not registered.
    """
    client_class = _email_client_registry.get(settings.email_backend)

    if not client_class:
        available = ", ".join(_email_client_registry.keys())
        raise RuntimeError(
            f"Unsupported email_backend: '{settings.email_backend}'. "
            f"Available backends: {available}"
        )

    return client_class()