email/writeconfig
1 minute read.
Last Modified 2021-02-04 11:38 ESTNamespace | Name | Admin Only | Log Summary | Generates Event | Version Added |
---|---|---|---|---|---|
writeconfig | yes | yes | yes | 1 (Removed in 1.2) |
This API namespace was depricated in version 1.1, and removed in version 1.2. Please look at the alertplugins/* API namespace for the repacement for this functionality.
Write SSMTP Configuration
- Required:
- “rootaddress” (String) : This email address will appear in the “From” field of email alerts
- “mailserver” (String) : Address to contact for email submissions (Example: “smtp.gmail.com”)
- “port” (String) : Port number to use when contacting the mail server (Example: “587”);
- “security” (String) (“TLS” or “STARTTLS” or “TLS+STARTTLS”)
- “AuthUser” (String) : Username to use when connecting to the mailserver
- “AuthPass” (String) : Password to use when connecting to the mailserver
- “AuthMethod” (String) : Type of authentication to mailserver (“LOGIN” is standard username/password).
{
"namespace" : "email",
"name" : "writeconfig",
"id" : "some_id",
"args" : {
"rootaddress" : "email@domain.com",
"mailserver" : "smtp.domain.com",
"port" : "587",
"security" "TLS+STARTTLS",
"AuthUser" "useraddress",
"AuthPass" "userpass",
"AuthMethod" : "LOGIN"
}
}
{
"namespace" : "email",
"name" : "response",
"id" : "some_id",
"args" : {
"result" : "success"
}
}