Sign in
settings

Send a test email using current SMTP settings (admin/superadmin)

post/settings/test-email

Request body

tostring required
systemEmailHoststring
systemEmailPortnumber
systemEmailSecureboolean
systemEmailPoolboolean
systemEmailAddressstring
systemEmailDisplayNamestring
systemEmailPasswordstring
systemEmailUserstring
systemEmailIgnoreTLSboolean
systemEmailRequireTLSboolean
systemEmailRejectUnauthorizedboolean

Response

OK

successtrue required
msgstring required

Changes

Changed in 3 of the 38 revisions of this API.165

  • 39082d385dda64See the full diff
    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 403 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 500 status

      response-optional-property-removed

    • ●

      added the new false enum value to the success response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new false enum value to the success response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new true enum value to the success response property for the response status 200

      response-property-enum-value-added

    • ○

      added optional request body

      request-body-added-optional

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the optional property data to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property data to the response with the 500 status

      response-optional-property-added

    This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • db719f9e3d341See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b97ec6888b3c1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog