(408) 943-4100               V   Commercial Support

email/writeconfig

  1 minute read.

Last Modified 2021-02-04 11:38 EST
NamespaceNameAdmin OnlyLog SummaryGenerates EventVersion Added
emailwriteconfigyesyesyes1 (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.

Description

Write SSMTP Configuration

Input Arguments

  • 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).

Request Example Arguments

{
  "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"
  }
}

Reply Example

{
  "namespace" : "email",
  "name" : "response",
  "id" : "some_id",
  "args" : {
    "result" : "success"
  }
}