cterasdk.core.mail module#
- class cterasdk.core.mail.Mail(core)#
Bases:
BaseCommand
Portal Mail Server Configuration APIs
- disable()#
Disable Mail Server Notifications
- enable(host=None, port=None, sender=None, username=None, password=None, use_tls=None)#
Enable Mail Server Notifications
- Parameters:
host (str,optional) – SMTP host
port (str,optional) – SMTP port
sender (str,optional) – Sender e-mail address
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 None
- is_enabled()#
Check if forwarding log messages over syslog is enabled
- modify(host=None, port=None, sender=None, username=None, password=None, use_tls=None)#
Modify Mail Server Configuration
- Parameters:
host (str,optional) – SMTP host
port (str,optional) – SMTP port
sender (str,optional) – Sender e-mail address
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 None