(408) 943-4100               V   Commercial Support

email/send_test

  1 minute read.

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

Send a test email to a designated address. This can be used for verifying that the system email configuration is setup properly and functional.

Input Arguments

  • Required:
    • “to” (String) or (JsonArray) : Email address(es) to send the test email to.

Request Example Arguments for single recipiant

{
  "namespace" : "email",
  "name" : "send_test",
  "id" : "some_id",
  "args" : {
    "to" : "address_1@domain.com"
  }
}

Request Example Arguments for multiple recipiants

{
  "namespace" : "email",
  "name" : "send_test",
  "id" : "some_id",
  "args" : {
    "to" : ["address_1@domain.com" , "address_2@domain.com"]
  }
}

Reply Example

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