Email API Parameters
Parameters are optional unless otherwise noted.
|
Parameter |
Description |
Notes |
|---|---|---|
|
smtpEnabled |
Whether this SMTP configuration is enabled. |
Boolean. Defaults to false. |
|
smtpAuthenticationEnabled |
Whether SMTP authentication is required for the SMTP host. |
Boolean. Defaults to false. |
|
smtpFromUser |
The email (reply-to) address of email sent by this server. |
Required when smtpEnabled = true. |
|
smtpHost |
The fully qualified host address of the SMTP server. |
Required when smtpEnabled = true. |
|
smtpHostUserName |
The username used to log into the SMTP server. |
Required when smtpAuthenticationEnabled = true. |
|
smtpHostUserPassword |
The password used to log into the SMTP server. |
Required when smtpAuthenticationEnabled = true. |
|
smtpPort |
The SMTP port. Default is 587. |
Required when smtpEnabled = true. |
|
smtpSslEnabled |
Whether SSL is enabled for the SMTP server. |
Boolean. Defaults to true. |