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.

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

Configuration Properties

Property Type Description
Enabled Boolean Should email-enabled tools (e.g., ISAM and SQL Agents) send administrative email messages?
SmtpServer string The DNS name or TCP/IP address of the SMTP server to use.
SmtpPort Integer The TCP/IP port number of the SMTP server.
ConsolePort Integer If the email server has a browser UI (e.g., SMTP4DEV), the port number where the UI can be accessed.
SmtpUsername String The optional username to use to authenticate with the SMTP server.
SmtpPassword String The optional password to use to authenticate with the SMTP server.
SmtpUseSSL Boolean Does the SMTP server require an SSL connection?
SenderAddress String The sender address to use when sending messages.
SenderName String The sender name to use when sending messages.
Recipients String array One or more recipient email addresses.
ErrorsBeforePause Integer If sending fails, the number of failed messages before pausing message sending.
ErrorPauseMinutes Integer If sending is paused because of errors, the number of minutes to wait before trying to resume message sending. Failed messages will NOT be resent.
EmailWarnings Boolean Should emails be generated by WARNING messages that occur?
EmailErrors Boolean Should emails be generated by ERROR messages that occur?