Send a test email
POST/api/v1/Email
Queues an email for delivery using the mail server details in the request, and returns the request. The console uses it to test mail server settings. The call fails if no email service is registered.
Permission required: Admin role (or the App role).
Values for importance: 0 = Low, 1 = Normal, 2 = High.
Values for priority: 0 = NonUrgent, 1 = Normal, 2 = Urgent.
Caution: The call queues a real email to the recipient address and also creates a settings record from the values in the request.
Request
Responses
- 200
- 400
- 403
The email was queued. The body repeats the request.
No email service is registered, or the email could not be queued. The body is an error message.
The signed-in user does not have the required role, or the account has read-only access.