Package software.xdev.mailpit.api

Class ApplicationApi

java.lang.Object

software.xdev.mailpit.client.BaseApi

software.xdev.mailpit.api.ApplicationApi

public class ApplicationApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.mailpit.client.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
ApplicationApi()
ApplicationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AppInformation	appInformation()	Get application information Returns basic runtime information, message totals and latest release version.
AppInformation	appInformation(Map<String,String> additionalHeaders)	Get application information Returns basic runtime information, message totals and latest release version.
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.
WebUIConfigurationResponse200Response	webUIConfigurationResponse()	Get web UI configuration Returns configuration settings for the web UI.
WebUIConfigurationResponse200Response	webUIConfigurationResponse(Map<String,String> additionalHeaders)	Get web UI configuration Returns configuration settings for the web UI.

Methods inherited from class software.xdev.mailpit.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationApi

public ApplicationApi()

ApplicationApi

public ApplicationApi(ApiClient apiClient)

Method Details

appInformation

public AppInformation appInformation()
                              throws ApiException

Get application information Returns basic runtime information, message totals and latest release version.

Returns:

AppInformation

Throws:

ApiException - if fails to make API call

appInformation

public AppInformation appInformation(Map<String,String> additionalHeaders)
                              throws ApiException

Get application information Returns basic runtime information, message totals and latest release version.

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

AppInformation

Throws:

ApiException - if fails to make API call

webUIConfigurationResponse

public WebUIConfigurationResponse200Response webUIConfigurationResponse()
                                                                 throws ApiException

Get web UI configuration Returns configuration settings for the web UI. Intended for web UI only!

Returns:

WebUIConfigurationResponse200Response

Throws:

ApiException - if fails to make API call

webUIConfigurationResponse

public WebUIConfigurationResponse200Response webUIConfigurationResponse(Map<String,String> additionalHeaders)
                                                                 throws ApiException

Get web UI configuration Returns configuration settings for the web UI. Intended for web UI only!

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

WebUIConfigurationResponse200Response

Throws:

ApiException - if fails to make API call

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.