Mailanbieter und Verbindungsstatus abrufen

{
  "operationId": "get_v2_settings_list_mailsystem",
  "summary": "Mailanbieter und Verbindungsstatus abrufen",
  "description": "Liest das aktive Mailsystem, SMTP-/Mailjet-Metadaten, Microsoft-Verbindungsstatus, DNS-Daten und aktuelle Versandhinweise. Passwort und Mailjet-Secret werden ausgelassen. Bei Microsoft können gespeicherte Tokens erneuert werden; für berechtigte Browser-Anmeldungen wird außerdem ein kurzlebiger OAuth-Autorisierungszustand mit Browsercookie für auth_url gespeichert. Daher ist dieser GET kein reiner Leseaufruf.",
  "tags": [
    "settings"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Anbieterkonfiguration mit Statusfeldern und optionalen externen DNS-/Account-Daten; sensible Inhalte vertraulich behandeln.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "mailsystem": {
                "smtp": false,
                "mailjet": false,
                "microsoft": false,
                "edoobox-email": true
              },
              "edoobox-email": {
                "email": "norply@edoobox.email"
              },
              "mailjet": {
                "active": false,
                "email": "office@example.invalid",
                "key": ""
              },
              "smtp": {
                "active": false,
                "email": "office@example.invalid",
                "user": "",
                "url": "",
                "port": 587,
                "authorize": true,
                "secure": "tls"
              },
              "microsoft": {
                "active": false,
                "email": "",
                "connection": false,
                "has_connection": false,
                "account": false,
                "auth_url": ""
              },
              "mail_system_alerts": []
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "mailsystem": {
                    "type": "object",
                    "properties": {
                      "smtp": {
                        "type": "boolean"
                      },
                      "mailjet": {
                        "type": "boolean"
                      },
                      "microsoft": {
                        "type": "boolean"
                      },
                      "edoobox-email": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": true
                  },
                  "edoobox-email": {
                    "type": "object",
                    "properties": {
                      "email": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  },
                  "mailjet": {
                    "type": "object",
                    "properties": {
                      "active": {
                        "type": "boolean"
                      },
                      "email": {
                        "type": "string"
                      },
                      "key": {
                        "type": "string"
                      },
                      "dns": {}
                    },
                    "additionalProperties": true
                  },
                  "smtp": {
                    "type": "object",
                    "properties": {
                      "active": {
                        "type": "boolean"
                      },
                      "email": {
                        "type": "string"
                      },
                      "user": {
                        "type": "string"
                      },
                      "url": {
                        "type": "string"
                      },
                      "port": {
                        "type": "integer"
                      },
                      "authorize": {
                        "type": "boolean"
                      },
                      "secure": {
                        "type": [
                          "string",
                          "boolean"
                        ]
                      }
                    },
                    "additionalProperties": true
                  },
                  "microsoft": {
                    "type": "object",
                    "properties": {
                      "active": {
                        "type": "boolean"
                      },
                      "email": {
                        "type": "string"
                      },
                      "connection": {
                        "type": "boolean"
                      },
                      "has_connection": {
                        "type": "boolean"
                      },
                      "account": {},
                      "auth_url": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  },
                  "mail_system_alerts": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {},
                      "additionalProperties": true
                    }
                  }
                },
                "additionalProperties": true
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Settings.php",
      "line": 2802,
      "reason": "Reads tenant SMTP/Mailjet/Microsoft configuration; skips Mailjet secret and SMTP password output in its outbound structures."
    },
    "reason": "Read mail settings, automatically refresh existing Microsoft credentials, and for authorized writers issue a new browser-bound Microsoft OAuth handoff.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-03.json",
      "pointer": "/operations/16",
      "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
      "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
    }
  },
  "x-edoobox-get-effect": "maintenance",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/16",
    "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-server-authorization": true,
  "x-edoobox-server-authorization-source": {
    "file": "application/libraries/edoobox/integrations/auth/OAuthAuthorizationState.php",
    "line": 27,
    "reason": "The native settings read admits read scope and existing-token maintenance. OAuth state issuance separately requires current admin settings level 3/4 and a non-read-only login; its caught denial leaves auth_url empty. Preserve this exact native branch distinction."
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/06-admin-settings.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Settings.php",
    "method": "getSettings",
    "line": 2408,
    "branch": {
      "file": "application/models/v2/Settings.php",
      "line": 2421
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "settings",
    "short": "setti",
    "checkedByDispatcher": true,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}