E-Mail-Server LANMailServer

LANMailServer bietet selbst die Möglichkeit, dass sich ein E-Mail-Programm oder Script per OAuth2 authentfiziert, um E-Mails abzurufen und/oder zu versenden.

In den Programmeinstellungen muss der HTTP-API/OAuth2-Server aktiviert werden, ansonsten steht die OAuth2-Authentisierung nicht zur Verfügung.

In der Dokumentation wird davon ausgegangen, dass der HTTP-API/OAuth2-Server auf HTTP Port 6080 ausgeführt wird.

Alle HTTP-GET-Parameter müssen URL-codiert übergeben werden.

Erfolgt 6 Monate kein Zugriff mit dem Token, wird dieser gelöscht, es muss eine erneute Browser-Authentisierung erfolgen.

Authorization Endpoint, Abruf Zugriffscode

Beispiel-URL

Der Aufruf der URL muss in einem Browser erfolgen, es muss korrekt Benutzername und Passwort eingegeben werden.

Beispiel-Rückgabe

Es wird die übergebene redirect_uri mit dem Parameter code= und, falls angegeben, state=<wert> zurückgegeben.

http://localhost/oauth2/code?state=state_parameter_passthrough_value&code=<CODE>

Treten Fehler auf, werden diese direkt im Browser angezeigt, z.B. parameter_error; client_id doesn't exists or is disabled.

AccessToken Endpoint, Tausch Code gegen Zugriffstoken

Der Tausch muss innerhalb von 30 Sekunden erfolgen, ansonsten verfällt der Code.

Beispiel-URL

Beispiel-Rückgabe (JSON)

{ "access_token": "1/abcedefghij", "expires_in": 3920, "token_type": "Bearer", "scope": "IMAP.AccessAsUser.All SMTP.Send", "refresh_token": "1/stuvwxyz" }

Treten Fehler auf, werden die Parameter error= und error_description= per Weiterleitung zurückgegeben.

http://localhost/oauth2/code?error=<fehlercode>&error_description=<fehlertext>

RefreshToken Endpoint, Aktualisierung des Zugriffstokens

Alle 60 Minuten verfällt der Zugriffstoken, es muss mit Hilfe des Aktualisierungstoken ein neuer Zugriffstoken und Aktualisierungstoken abgerufen werden.

Beispiel-URL

Beispiel-Rückgabe (JSON)

{ "access_token": "NEU_1/abcedefghij", "expires_in": 3920, "token_type": "Bearer", "scope": "IMAP.AccessAsUser.All SMTP.Send", "refresh_token": "NEU_1/stuvwxyz" }

Treten Fehler auf, wird ein JSON-Array mit error und error_description zurückgegeben.

{ "error": "<fehlercode>", "error_description": "<fehlertext>" }

Abmeldung/Logout

Beispiel-URL

Beispiel-Rückgabe

Es wird HTTP-Fehler 200 zurückgegeben.

Treten Fehler auf, wird ein HTTP-Fehler 400 und ein JSON-Array mit error und error_description zurückgegeben.

{ "error": "<fehlercode>", "error_description": "<fehlertext>" }