SMTP Commands
A list of SMTP configuration settings that are customizable by local administrators.
Variables listed as critical must be present in the system configuration file when used during initial deployment (for example, automatic configuration). Variables listed as required must be present if the server holds one or more of the roles listed in the applies to field.
Command | Type | Required | Default | Function |
---|---|---|---|---|
smtp | Mapping | No | Settings for SMTP (sending email). | |
smtp.auth | String | No | none |
The SMTP authentication method to use. Choices: none / plain |
smtp.host | String | No | The host name or IP address of the SMTP relay server (required when smtp.mode is relay). | |
smtp.mode | String | Yes |
SMTP connection method. Choices: direct / none / relay |
|
smtp.port | Number | No | 25 | The port on the SMTP relay server. |
smtp.security | String | No |
The SMTP security method to use (only valid when smtp.auth is not none). Choices: none / starttls |
|
smtp.username | String | No | The user name used to authenticate to the SMTP server (required when smtp.auth is plain). | |
smtp.password | String | No | The password used to authenticate to the SMTP server (required when smtp.auth is plain). |