Skip to main content

Email

Send email notifications.

Attributes​

AttributeTypeDescription
recipientsTuple[str, ...]Email addresses for the "to" field.
ccTuple[str, ...] = ()Optional email addresses for the "cc" field.
bccTuple[str, ...] = ()Optional email addresses for the "bcc" field.
subjectstr = "Task {task.name} {run.phase}"Email subject template (supports template variables).
bodystr = "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_bodyOptional[str] = NoneOptional HTML body template (supports template variables). When provided, the email is sent as multipart with both plain text and HTML.

Constructor​

Signature​

def Email(
recipients: Tuple[str, ...],
cc: Tuple[str, ...] = (),
bcc: Tuple[str, ...] = (),
subject: str = "Task {task.name} {run.phase}",
body: str = "Task: {task.name}\nRun: {run.name}\nProject/Domain: {project}/{domain}\nPhase: {run.phase}\nDuration: {run.duration}\nDetails: {run.url}\n",
html_body: Optional[str] = None
) -> None

Parameters​

NameTypeDescription
recipientsTuple[str, ...]Email addresses for the "to" field.
ccTuple[str, ...] = ()Optional email addresses for the "cc" field.
bccTuple[str, ...] = ()Optional email addresses for the "bcc" field.
subjectstr = "Task {task.name} {run.phase}"Email subject template (supports template variables).
bodystr = "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_bodyOptional[str] = NoneOptional HTML body template (supports template variables). When provided, the email is sent as multipart with both plain text and HTML.