Email

Send email notifications.

Attributes

Attribute	Type	Description
recipients	Tuple[str, ...]	Email addresses for the "to" field.
cc	Tuple[str, ...] = ()	Optional email addresses for the "cc" field.
bcc	Tuple[str, ...] = ()	Optional email addresses for the "bcc" field.
subject	str = "Task {task.name} {run.phase}"	Email subject template (supports template variables).
body	str = "Task: {task.name}\nRun: {run.name}\nProject/Domain: {project}/{domain}\nPhase: {run.phase}\nDuration: {run.duration}\nDetails: {run.url}\n"	Plain text body template (supports template variables).
html_body	Optional[str] = null	Optional HTML body template (supports template variables) which, when provided, causes the email to be sent as multipart.

---

Constructor

Signature

def Email(
    on_phase: Union[[ActionPhase](../../models/actionphase.md?sid=flyte_models_actionphase), Iterable[[ActionPhase](../../models/actionphase.md?sid=flyte_models_actionphase)]],
    recipients: Tuple[str, ...],
    cc: Tuple[str, ...] = (),
    bcc: Tuple[str, ...] = (),
    subject: str = 'Task {task.name} {run.phase}',
    body: str = 'Task: {task.name}\nRun: {run.name}\n...',
    html_body: Optional[str] = None
) - > null

Parameters

Name	Type	Description
on_phase	Union[[ActionPhase](../../models/actionphase.md?sid=flyte_models_actionphase), Iterable[[ActionPhase](../../models/actionphase.md?sid=flyte_models_actionphase)]]	ActionPhase(s) to trigger notification.
recipients	Tuple[str, ...]	Email addresses for the 'to' field.
cc	Tuple[str, ...] = ()	Optional email addresses for the 'cc' field.
bcc	Tuple[str, ...] = ()	Optional email addresses for the 'bcc' field.
subject	str = 'Task {task.name} {run.phase}'	Email subject template.
body	str = 'Task: {task.name}\nRun: {run.name}\n...'	Plain text body template.
html_body	Optional[str] = None	Optional HTML body template.

---