Test Instance Email Setting

Access

Requires an instance administrator. A normal authenticated account cannot perform this operation.

This call sends an email

Uses the supplied email settings or the stored configuration and sends a test message to recipientEmail, falling back to the calling administrator's email when omitted. It does not persist or enable the configuration. An empty effective recipient is invalid. Successful completion has no result object beyond {}.

Successful response

This operation has no resource to return. The Rust REST transport serializes protobuf Empty as HTTP 200 with JSON {}. The empty success-schema area in the generated contract is intentional, not missing request instructions.

Request

Tests notification email delivery with the provided or stored SMTP settings.

Parameters

No path or query parameters are declared.

Request body

Required

application/json · TestInstanceEmailSettingRequest

Responses

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

{
  "tags": [
    "InstanceService"
  ],
  "description": "Tests notification email delivery with the provided or stored SMTP settings.",
  "operationId": "InstanceService_TestInstanceEmailSetting",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/TestInstanceEmailSettingRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {}
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}