Open MCP Portaldocs
ReferenceNotifications

Send a test email to the caller's own address (platform admins)

POST
/v1/admin/settings/notifications/test-email

Always to the caller's own address (never an address from the request), through the configured SMTP server, and reports the outcome in the 200 body (ok false with errorClass: not_allowed, connect, tls, auth, rejected, address, timeout). 409 email_not_configured when SMTP_HOST is unset. 429 rate_limited after 5 tests per hour per admin. Audited as settings.notifications_test_email.

Response Body

The outcome of the test

application/json
  1. response
data*
curl -X POST 'https://mcp.example.com/v1/admin/settings/notifications/test-email'
{  "data": {    "ok": true,    "errorClass": "not_allowed",    "httpStatus": 0,    "durationMs": 0,    "message": "string"  }}