cterasdk.edge.mail module

cterasdk.edge.mail module#

class cterasdk.edge.mail.Alerts(edge)#

Bases: BaseCommand

get()#

Get Alert Settings

Returns:

Alert settings

Return type:

cterasdk.edge.types.AlertSettings

modify(alerts)#

Modify Alert Settings

Parameters:

alerts (cterasdk.edge.types.AlertSettings) – Alert Settings

class cterasdk.edge.mail.Mail(edge)#

Bases: BaseCommand

Edge Filer Mail Server configuration APIs

Variables:

alerts (cterasdk.edge.mail.alerts) – Object holding the Edge Filer e-mail alert APIs

disable()#

Disable e-mail delivery using a custom SMTP server

enable(smtp_server, port=25, username=None, password=None, use_tls=True, sender=None, recipients=None, min_severity=None)#

Enable e-mail delivery using a custom SMTP server

Parameters:

  • smtp_server (str) – Address of the SMTP Server

  • port (int,optional) – The listening port of the SMTP Server, defaults to 25

  • username (str,optional) – The user name of the SMTP Server, defaults to None

  • password (str,optional) – The password of the SMTP Server, defaults to None

  • use_tls (bool,optional) – Use TLS when connecting to the SMTP Server, defaults to True

  • sender (str,optional) – Sender e-mail address

  • recipients (list[str],optional) – List of e-mail recipients

  • severity (cterasdk.edge.enum.Severity) – Minimum severity level to trigger email alerts