Package de.svws_nrw.api.server

Klasse APIEmail

java.lang.Object

de.svws_nrw.api.server.APIEmail

@Path("/db/{schema}/email")
@Produces("application/json")
@Consumes("application/json")
public class APIEmail
extends Object

Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die Email-Funktionen des SVWS-Servers.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
APIEmail()	Leerer Standardkonstruktor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
jakarta.ws.rs.core.Response	getSMTPServerKonfiguration(String schema, jakarta.servlet.http.HttpServletRequest request)	Die OpenAPI-Methode für die Abfrage der SMTP-Server-Konfiguration der Schule.
jakarta.ws.rs.core.Response	patchSMTPServerKonfiguration(String schema, InputStream is, jakarta.servlet.http.HttpServletRequest request)	Die OpenAPI-Methode für das Anpassen der SMTP-Server-Konfiguration der Schule.

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

APIEmail

public APIEmail()

Leerer Standardkonstruktor.

Methodendetails

getSMTPServerKonfiguration

@GET
@Path("/smtp/server/konfiguration")
public jakarta.ws.rs.core.Response getSMTPServerKonfiguration(@PathParam("schema")
 String schema,
 @Context
 jakarta.servlet.http.HttpServletRequest request)

Die OpenAPI-Methode für die Abfrage der SMTP-Server-Konfiguration der Schule.

Parameter:

schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll

request - die Informationen zur HTTP-Anfrage

Gibt zurück:

die SMTP-Server-Konfiguration

patchSMTPServerKonfiguration

@PATCH
@Path("/smtp/server/konfiguration")
public jakarta.ws.rs.core.Response patchSMTPServerKonfiguration(@PathParam("schema")
 String schema,
 InputStream is,
 @Context
 jakarta.servlet.http.HttpServletRequest request)

Die OpenAPI-Methode für das Anpassen der SMTP-Server-Konfiguration der Schule.

Parameter:

schema - das Datenbankschema, auf welches der Patch ausgeführt werden soll

is - der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386

request - die Informationen zur HTTP-Anfrage

Gibt zurück:

das Ergebnis der Patch-Operation