Skip to content

Email Configuration

The ISAM and SQL Agents are able to send certain administrative alerts via email messages. To enable this capability, you must configure the email environment using the Email property in MasterConfig.json.

Configuration Properties

Property Type Description
Enabled Boolean
SmtpServer string
SmtpPort Integer
ConsolePort Integer
SmtpUsername String
SmtpPassword String
SmtpUseSSL Boolean
SenderAddress String
SenderName String
Recipients String array
ErrorsBeforePause Integer
ErrorPauseMinutes Integer

Example Configuration

{
  "Email": {
    "Enabled": true,
    "SmtpServer": "localhost",
    "SmtpPort": 2525,
    "ConsolePort": 5125,
    "SmtpUsername": "",
    "SmtpPassword": "",
    "SmtpUseSSL": false,
    "SenderAddress": "sqlagent@me.local",
    "SenderName": "SQLAgent",
    "Recipients": [
      "admins@me.local"
    ],
    "ErrorsBeforePause": 3,
    "ErrorPauseMinutes": 10
  }
}