The configuration for reporting alerts via email server. If alert reporting via web server is enabled (/config/alert/reporter/web/uri is not empty), reporting via email server is disabled.
Normal response.
Unauthorized response.
{- "result": {
- "server": "smtp.mail.com",
- "user": "egaugealert@mail.com",
- "password": "string",
- "from-address": "eGauge1345",
- "to": [
- {
- "format": "string",
- "min-priority": 3,
- "address": "user@site.com"
}
]
}, - "error": "Error message (present if an error occurred)."
}| server | string (configAlertReporterMailServer) The hostname of a mail server that speaks the SMTP protocol. If this is set to an empty string, the meter will attempt to deliver mail directly to the destination host. Many Internet service providers block direct mail delivery, so leaving this string empty generally results in alert emails getting blocked. |
| user | string (configAlertReporterMailUser) The user name to provide to the email server for authentication purposes. |
| password | string (configAlertReporterMailPassword) The password to provide to the email server for authentication purposes. This resource is write-only. |
| from-address | string (configAlertReporterMailFromAddress) The "From" email address to use when sending an email alert. If set to an empty string, the email server will use a default address. |
Array of objects (configAlertReporterMailTo) The email destinations to send the alerts to. |
Normal response.
Unauthorized response.
{ }{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}| server | string (configAlertReporterMailServer) The hostname of a mail server that speaks the SMTP protocol. If this is set to an empty string, the meter will attempt to deliver mail directly to the destination host. Many Internet service providers block direct mail delivery, so leaving this string empty generally results in alert emails getting blocked. |
| user | string (configAlertReporterMailUser) The user name to provide to the email server for authentication purposes. |
| password | string (configAlertReporterMailPassword) The password to provide to the email server for authentication purposes. This resource is write-only. |
| from-address | string (configAlertReporterMailFromAddress) The "From" email address to use when sending an email alert. If set to an empty string, the email server will use a default address. |
Array of objects (configAlertReporterMailTo) The email destinations to send the alerts to. |
Normal response.
Unauthorized response.
{ }{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}Reset to default (email reporting disabled).
Normal response.
Unauthorized response.
{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}