Skip to main content
POST
/
send_test_email
Send test email
curl --request POST \
  --url https://yourdomain.com/send_test_email \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaign": "test",
  "mail_data": "<string>",
  "supplied_mail_to": "<string>",
  "supplied_mail_server": "<string>",
  "supplied_smtp_from": "<string>",
  "supplied_link": "<string>",
  "supplied_id_param": "<string>",
  "target_id": "test",
  "supplied_first_name": "<string>",
  "supplied_last_name": "<string>",
  "supplied_position": "<string>",
  "supplied_custom_replacement": "<string>",
  "secure_mail": false,
  "supplied_username": "<string>",
  "supplied_password": "<string>",
  "dkim": false
}
'
"email sent"

Authorizations

Admin cookie authentication (configurable in config.json)

Body

application/json
campaign
string
default:test

Campaign name

mail_data
string

Raw email message

supplied_mail_to
string

Test recipient email

supplied_mail_server
string

Mail server hostname

supplied_smtp_from
string

SMTP from address

Phishing link URL

supplied_id_param
string

Tracking parameter name

target_id
string
default:test

Test target ID

supplied_first_name
string

Test first name

supplied_last_name
string

Test last name

supplied_position
string

Test position

supplied_custom_replacement
string

Test custom field

secure_mail
boolean
default:false

Use TLS

supplied_username
string

SMTP username

supplied_password
string

SMTP password

dkim
boolean
default:false

DKIM sign message

Response

Test email sent successfully

The response is of type string.

Example:

"email sent"