Smtp (Section)#

Path: /facilities/email-providers/email-provider/smtp

Parameters#

NameTypeRequiredDefaultDescription
smtp-hostunion (union (string | string) | string (length: 1..253))required-The SMTP host
smtp-portuint16optional587Sending port
enable-tlsbooleanoptionaltrueShould this email-subsystem use TLS
default-senderstringrequired-An RFC822 email address that will be used as the from name when sending emails
message-id-domainstringoptional-Override the domain part of the auto-generated Message-ID email header. When configured, the Message-ID will be in the format <uuid.timestamp@message-id-domain>, preventing server hostnames from being exposed in outgoing emails.

Subsections#

NameTypeDescription
dkimSectionDKIM configuraiton settings
tlsSectionTLS configuration settings
authenticationOneOfThe authentication method to use when connecting to the SMTP server. When omitted, no authentication is used. Basic (username/password) and OAuth are mutually exclusive.

Was this helpful?