workflows.services.executors.email

Email step executor.

Classes

EmailParts	Internal container for resolved email components.
EmailExecutor	Send an email using either a named template or a simple subject/body.

Module Contents

class workflows.services.executors.email.EmailParts

Internal container for resolved email components.

to: tuple[str, Ellipsis]

cc: tuple[str, Ellipsis]

bcc: tuple[str, Ellipsis]

from_email: str | None

template_ctx: dict[str, Any]

dj: Any

class workflows.services.executors.email.EmailExecutor

Bases: workflows.services.executors.factory.AbstractStepExecutor

Send an email using either a named template or a simple subject/body.

do_execute(instance, _signal)

Execute the email step.

Parameters:

• instance (workflows.models.WorkflowInstance) – Workflow instance being executed.

• _signal (str | None) – Optional signal (unused for email steps).

Returns:

ExecutorResult describing the outcome of sending the email.

Return type:

workflows.services.types.ExecutorResult

static _prepare_recipients_and_context(params, instance)

Prepare normalized recipients and template context.

Parameters:

• params (dict[str, Any])

• instance (workflows.models.WorkflowInstance)

Return type:

EmailParts

static _error_result(message, *, outputs=None)

Return a standardized FAILED result for this email step.

Parameters:

• message (str) – Human-readable error description.

• outputs (dict[str, Any] | None) – Optional additional output fields to include in the context.

Returns:

ExecutorResult with FAILED state and error details.

Return type:

workflows.services.types.ExecutorResult

_send_template_email(params, template_key, parts)

Handle template-based email sending.

Parameters:

• params (dict[str, Any])

• template_key (str)

• parts (EmailParts)

Return type:

workflows.services.types.ExecutorResult

_send_custom_email(params, parts)

Handle plain-text email sending.

Parameters:

• params (dict[str, Any])

• parts (EmailParts)

Return type:

workflows.services.types.ExecutorResult