SMTPSettings

class pydelfini.delfini_core.models.smtp_settings.SMTPSettings(enabled=False, from_address=Unset, host=Unset, password=Unset, port=587, site_name='Delfini', use_ssl=False, use_tls=True, username=Unset, verify_cert=True)[source]

Bases: object

SMTPSettings model

Parameters:
enabled

Master switch for outbound mail. When false, no notification email is sent regardless of any per-user preference. Default: False.

Type:

Union[Unset, bool]

from_address
Type:

Union[Unset, str]

host
Type:

Union[Unset, str]

password

Stored and returned in plaintext, as the OAuth and datastore credentials in this same response already are. Reading it requires the admin.config grant. Credentials are never transmitted over an unencrypted connection: a username set without use_tls or use_ssl is refused rather than sent in the clear.

Type:

Union[None, Unset, str]

port

Default: 587.

Type:

Union[Unset, int]

site_name

Branding shown in the header and footer of every notification email. Default: ‘Delfini’.

Type:

Union[Unset, str]

use_ssl

Use implicit TLS (“SMTPS”), encrypted from the first byte, which is what a relay on port 465 expects. Mutually exclusive with use_tls. Default: False.

Type:

Union[Unset, bool]

use_tls

Use STARTTLS, which is what most relays on port 587 expect. Mutually exclusive with use_ssl. Default: True.

Type:

Union[Unset, bool]

username
Type:

Union[None, Unset, str]

verify_cert

Verify the server’s certificate. Turn off only for an internal relay with a private CA; the connection stays encrypted but is no longer authenticated. Default: True.

Type:

Union[Unset, bool]

Attributes

enabled

from_address

host

password

port

site_name

use_ssl

use_tls

username

verify_cert

additional_properties

additional_keys

classmethod from_dict(src_dict)[source]

Create an instance of SMTPSettings from a dict

Parameters:

src_dict (Dict[str, Any])

Return type:

T

to_dict()[source]

Convert to a dict

Return type:

Dict[str, Any]