DocumentationAPI reference

Rust · 0.1.0

TestInstanceEmailSettingRequest

Application protocol schema. Field names and inherited descriptions are kept in their original language.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

Shape and fields

object

Request message for TestInstanceEmailSetting method.

FieldType / requirementDescription
emailallOf
NotificationSetting_EmailSetting
Optional. SMTP email settings to test. If omitted, the stored notification email setting is used.
recipientEmailstringOptional. Recipient email address. If omitted, the current user's email address is used.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "email": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationSetting_EmailSetting"
        }
      ],
      "description": "Optional. SMTP email settings to test. If omitted, the stored notification email setting is used."
    },
    "recipientEmail": {
      "type": "string",
      "description": "Optional. Recipient email address. If omitted, the current user's email address is used."
    }
  },
  "description": "Request message for TestInstanceEmailSetting method."
}