Email Server LANMailServer

LANMailServer itself provides the capability for an email program or script to authenticate using OAuth2 to retrieve and/or send emails.

In the program settings, the HTTP-API/OAuth2 server must be enabled; otherwise, OAuth2 authentication will not be available.

The documentation assumes that the HTTP-API/OAuth2 server is running on HTTP Port 6080.

All HTTP-GET parameters must be URL-encoded.

If there is no access using the token for 6 months, it will be deleted, and a new browser authentication will be required.

Authorization endpoint, retrieve access code

Example URL

The URL must be accessed in a browser, and the username and password must be entered correctly.

Example Response

The provided redirect_uri is returned with the parameters code= and, if specified, state=<value>.

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

If errors occur, they are displayed directly in the browser, e.g., parameter_error; client_id doesn't exist or is disabled.

AccessToken endpoint, exchange code for access token

The exchange must take place within 30 seconds; otherwise, the code will expire.

Example URL

Example Response (JSON)

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

If errors occur, the parameters error= and error_description= are returned via redirection.

http://localhost/oauth2/code?error=<errorcode>&error_description=<errortext>

RefreshToken endpoint, updating access token

Every 60 minutes the access token expires, and a new access token and refresh token must be retrieved using the refresh token.

Example URL

Example Response (JSON)

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

If errors occur a JSON array with parameters error= and error_description= are returned.

{ "error": "<errorcode>", "error_description": "<errortext>" }

Logout

Example URL

Response

HTTP error 200 will be returned.

If errors occur a JSON array with parameters error= and error_description= are returned.

{ "error": "<errorcode>", "error_description": "<errortext>" }