Email (SMTP)

Send email using the SMTP protocol.

Commands

Properties

Enable

Enable the email sender.

  • Data type: boolean
  • Default: false
  • Configuration

CLI: (cli)> config system notification email enable

SMTP Server

The SMTP server that will receive the email.

  • Data type: string
  • Default: smtp.example.com
  • Configuration
  • Required

CLI: (cli)> config system notification email server

SMTP Port

The SMTP port the server is listening on.

  • Data type: integer
  • Default: 587
  • Minimum: 1
  • Maximum: 65535
  • Configuration
  • Required

CLI: (cli)> config system notification email port

SMTP Connection Protocol

The protocol required to connect to the SMTP server.

OptionLabelDescription
unencryptedUnencryptedPlain text SMTP with no encryption.
starttlsStartTLSStart the connection using TLS and fallback to unencrypted if that fails.
tlsTLS OnlyRequire the connection to use TLS encryption.
  • Data type: string select
  • Default: starttls
  • Configuration
  • Required

CLI: (cli)> config system notification email protocol

Sender Address

The email address messages will be sent from.

  • Data type: string
  • Default: user@example.com
  • Configuration
  • Required

CLI: (cli)> config system notification email sender

Username

The username required to authenticate the connection.

  • Data type: string
  • Configuration
  • Optional

CLI: (cli)> config system notification email username

Password

The password required to authenticate the connection.

  • Data type: string
  • Configuration
  • Optional

CLI: (cli)> config system notification email password