setSmtpConfiguration

This procedure sets the SMTP configuration required by the sendMail procedure.

Please note that omitting parameters or specifying a null value/empty string for them will not change the value in the SMTP configuration. All parameters may be omitted or set to null.

Usage

SYSADMIN Procedure

SQL

CALL "SYSADMIN.setSmtpConfiguration"(
    "hostname" => 'string_hostname',
    "port" => integer_port,
    "ssl" => boolean_ssl,
	"starttls" => boolean_tls,
    "username" => 'string_username',
    "password" => 'string_password',
	"fromAddr" => 'string_fromAddr',
	"maxRetries" => integer_maxRetries,
	"responseTimeout" => integer_responseTimeout
) ;;

UTILS Procedure

SQL

CALL "UTILS.setSmtpConfiguration"(
    "hostname" => 'string_hostname',
    "port" => integer_port,
    "ssl" => boolean_ssl,
	"starttls" => boolean_tls,
    "username" => 'string_username',
    "password" => 'string_password',
	"fromAddr" => 'string_fromAddr',
	"maxRetries" => integer_maxRetries,
	"responseTimeout" => integer_responseTimeout
) ;;

Parameters

Parameter	Description
`hostname`	New SMTP server hostname
`port`	New SMTP server port
`ssl`	New SSL setting
`starttls`	New TLS setting
`username`	New SMTP server username
`password`	New SMTP server unencrypted password. To set an encrypted password, `importSmtpConfiguration` may be used
`fromAddr`	New email address to be used as a "from" address; mandatory
`maxRetries`	Maximum number of retry attempts for sending the email. If `NULL`, the default value `4` will be used
`responseTimeout`	Timeout (in seconds) for the SMTP server response. If `NULL`, the default value `10` will be used

Examples

SYSADMIN Procedure

SQL

CALL "SYSADMIN.setSmtpConfiguration"(
    "hostname" => 'example_host',
    "port" => 12345,
    "ssl" => true,
	"starttls" => false,
    "username" => 'smtp-user',
    "password" => 'secret',
    "maxRetries" => 2,
    "responseTimeout" => 30
) ;;

UTILS Procedure

SQL

CALL "UTILS.setSmtpConfiguration"(
    "hostname" => 'example_host',
    "port" => 12345,
    "ssl" => true,
	"starttls" => false,
    "username" => 'smtp-user',
    "password" => 'secret',
    "maxRetries" => 2,
    "responseTimeout" => 30
) ;;

maxRetries and responseTimeout parameters are available since v25.3