settingsAPI-Referenz

PUT/v2/settings/{id}/mailsystem/smtp

SMTP-Versand konfigurieren und prüfen

Prüft SMTP-Verbindungsdaten durch Versand einer Testmail und speichert bei Erfolg die Konfiguration als aktives Mailsystem. Ein vorhandenes Passwort kann wiederverwendet werden. Accountweite Versandsperre und begrenzte Verbindungsversuche bleiben maßgeblich. active/authorize werden nativ als Wahrheitswerte normalisiert; port wird zur Ganzzahl konvertiert. Der Account wird aus der Anmeldung bestimmt; der Pfad-id ist nur der generische Selektor.

Operation-ID put_v2_settings_id_mailsystem_smtp

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

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.

Ressource: settings · setti
Levels: 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

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.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Pfadparameter

iderforderlich

Öffentliche account-ID.

string

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^account_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"account_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^account_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.",
  "examples": [
    "account_012345abcdef_123456"
  ]
}

Request Body

erforderlich

`application/json`

object

data object erforderlich

Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "boolean"
}

email string erforderlich

format: "email"

user Typ nicht eingeschränkt erforderlich

password string writeOnly

Kann entfallen, wenn ein gespeichertes Passwort wiederverwendbar ist.

url Typ nicht eingeschränkt erforderlich

port number | string erforderlich

Wird zur Ganzzahl konvertiert und muss positiv sein.

Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "boolean"
}

secure string | boolean | null erforderlich

ssl, tls oder ein leerer/false-Wert für unverschlüsselt; andere Werte normalisiert der Legacy-Getter.

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "active": {
          "type": [
            "string",
            "number",
            "boolean",
            "null",
            "array",
            "object"
          ],
          "x-edoobox-canonicalType": "boolean"
        },
        "email": {
          "type": "string",
          "format": "email"
        },
        "user": {},
        "password": {
          "type": "string",
          "writeOnly": true,
          "description": "Kann entfallen, wenn ein gespeichertes Passwort wiederverwendbar ist."
        },
        "url": {},
        "port": {
          "type": [
            "number",
            "string"
          ],
          "description": "Wird zur Ganzzahl konvertiert und muss positiv sein."
        },
        "authorize": {
          "type": [
            "string",
            "number",
            "boolean",
            "null",
            "array",
            "object"
          ],
          "x-edoobox-canonicalType": "boolean"
        },
        "secure": {
          "type": [
            "string",
            "boolean",
            "null"
          ],
          "description": "ssl, tls oder ein leerer/false-Wert für unverschlüsselt; andere Werte normalisiert der Legacy-Getter."
        }
      },
      "additionalProperties": true,
      "required": [
        "active",
        "email",
        "user",
        "url",
        "port",
        "authorize",
        "secure"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

SMTP-Versand konfigurieren und prüfen

{
  "data": {
    "active": true,
    "email": "office@example.invalid",
    "user": "office@example.invalid",
    "password": "synthetic-smtp-password",
    "url": "smtp.example.invalid",
    "port": 587,
    "authorize": true,
    "secure": "tls"
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

Account-ID und update; je Anbieter zusätzlich connect_error, Restversuche, Prüfdaten oder disconnected.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data object

id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^account_[a-f0-9]{12}_-?[0-9]+$"

update boolean erforderlich

connect_error boolean

too_many_tries integer

connect_error_code object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

disconnected boolean

verification string

mailjet object

dns Typ nicht eingeschränkt

webhook Typ nicht eingeschränkt

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^account_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
        },
        "update": {
          "type": "boolean"
        },
        "connect_error": {
          "type": "boolean"
        },
        "too_many_tries": {
          "type": "integer"
        },
        "connect_error_code": {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        },
        "disconnected": {
          "type": "boolean"
        },
        "verification": {
          "type": "string"
        },
        "mailjet": {
          "type": "object",
          "properties": {
            "dns": {},
            "webhook": {}
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "update"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "account_012345abcdef_123456",
    "update": true,
    "connect_error": false
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

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.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Settings.php:2324updateSettings()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-routeAliasEvidence

{
  "file": "application/models/v2/Settingsfunc.php",
  "line": 591,
  "reason": "Settings update dispatch selects mailsystem/provider while current.id is the account v2 ID returned by GETsettings; source supports this exact provider."
}

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": "updateSettings",
  "line": 2324,
  "branch": {
    "file": "application/models/v2/Settingsfunc.php",
    "line": 615
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "settings",
  "short": "setti",
  "checkedByDispatcher": true,
  "levels": [
    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."
}

Vollständige Operation als JSON

{
  "operationId": "put_v2_settings_id_mailsystem_smtp",
  "summary": "SMTP-Versand konfigurieren und prüfen",
  "description": "Prüft SMTP-Verbindungsdaten durch Versand einer Testmail und speichert bei Erfolg die Konfiguration als aktives Mailsystem. Ein vorhandenes Passwort kann wiederverwendet werden. Accountweite Versandsperre und begrenzte Verbindungsversuche bleiben maßgeblich. active/authorize werden nativ als Wahrheitswerte normalisiert; port wird zur Ganzzahl konvertiert. Der Account wird aus der Anmeldung bestimmt; der Pfad-id ist nur der generische Selektor.",
  "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": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^account_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.",
        "examples": [
          "account_012345abcdef_123456"
        ]
      },
      "description": "Öffentliche account-ID."
    },
    {
      "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": "Account-ID und update; je Anbieter zusätzlich connect_error, Restversuche, Prüfdaten oder disconnected.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "account_012345abcdef_123456",
              "update": true,
              "connect_error": false
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^account_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                  },
                  "update": {
                    "type": "boolean"
                  },
                  "connect_error": {
                    "type": "boolean"
                  },
                  "too_many_tries": {
                    "type": "integer"
                  },
                  "connect_error_code": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true
                  },
                  "disconnected": {
                    "type": "boolean"
                  },
                  "verification": {
                    "type": "string"
                  },
                  "mailjet": {
                    "type": "object",
                    "properties": {
                      "dns": {},
                      "webhook": {}
                    },
                    "additionalProperties": true
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "update"
                ]
              },
              "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,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "active": {
                  "type": [
                    "string",
                    "number",
                    "boolean",
                    "null",
                    "array",
                    "object"
                  ],
                  "x-edoobox-canonicalType": "boolean"
                },
                "email": {
                  "type": "string",
                  "format": "email"
                },
                "user": {},
                "password": {
                  "type": "string",
                  "writeOnly": true,
                  "description": "Kann entfallen, wenn ein gespeichertes Passwort wiederverwendbar ist."
                },
                "url": {},
                "port": {
                  "type": [
                    "number",
                    "string"
                  ],
                  "description": "Wird zur Ganzzahl konvertiert und muss positiv sein."
                },
                "authorize": {
                  "type": [
                    "string",
                    "number",
                    "boolean",
                    "null",
                    "array",
                    "object"
                  ],
                  "x-edoobox-canonicalType": "boolean"
                },
                "secure": {
                  "type": [
                    "string",
                    "boolean",
                    "null"
                  ],
                  "description": "ssl, tls oder ein leerer/false-Wert für unverschlüsselt; andere Werte normalisiert der Legacy-Getter."
                }
              },
              "additionalProperties": true,
              "required": [
                "active",
                "email",
                "user",
                "url",
                "port",
                "authorize",
                "secure"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "SMTP-Versand konfigurieren und prüfen",
            "value": {
              "data": {
                "active": true,
                "email": "office@example.invalid",
                "user": "office@example.invalid",
                "password": "synthetic-smtp-password",
                "url": "smtp.example.invalid",
                "port": 587,
                "authorize": true,
                "secure": "tls"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-routeAliasEvidence": {
    "file": "application/models/v2/Settingsfunc.php",
    "line": 591,
    "reason": "Settings update dispatch selects mailsystem/provider while current.id is the account v2 ID returned by GETsettings; source supports this exact provider."
  },
  "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": "updateSettings",
    "line": 2324,
    "branch": {
      "file": "application/models/v2/Settingsfunc.php",
      "line": 615
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "settings",
    "short": "setti",
    "checkedByDispatcher": true,
    "levels": [
      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."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_ID:?PATH_ID setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "active": true,
    "email": "office@example.invalid",
    "user": "office@example.invalid",
    "password": "synthetic-smtp-password",
    "url": "smtp.example.invalid",
    "port": 587,
    "authorize": true,
    "secure": "tls"
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'PUT' \
  --url "${API_ORIGIN%/}"'/v2/settings/'"${PATH_ID}"'/mailsystem/smtp' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/settings/{id}/mailsystem/smtp";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "active": true,
    "email": "office@example.invalid",
    "user": "office@example.invalid",
    "password": "synthetic-smtp-password",
    "url": "smtp.example.invalid",
    "port": 587,
    "authorize": true,
    "secure": "tls"
  }
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/settings/{id}/mailsystem/smtp"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"active\":true,\"email\":\"office@example.invalid\",\"user\":\"office@example.invalid\",\"password\":\"synthetic-smtp-password\",\"url\":\"smtp.example.invalid\",\"port\":587,\"authorize\":true,\"secure\":\"tls\"}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/settings/{id}/mailsystem/smtp";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "active": true,
    "email": "office@example.invalid",
    "user": "office@example.invalid",
    "password": "synthetic-smtp-password",
    "url": "smtp.example.invalid",
    "port": 587,
    "authorize": true,
    "secure": "tls"
  }
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/settings/{id}/mailsystem/smtp"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"active\":true,\"email\":\"office@example.invalid\",\"user\":\"office@example.invalid\",\"password\":\"synthetic-smtp-password\",\"url\":\"smtp.example.invalid\",\"port\":587,\"authorize\":true,\"secure\":\"tls\"}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.