Package software.xdev.mailpit.api

Class OtherApi

java.lang.Object

software.xdev.mailpit.client.BaseApi

software.xdev.mailpit.api.OtherApi

public class OtherApi
extends BaseApi

Field Summary

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

apiClient

Constructor Summary

Constructors

Constructor	Description
OtherApi()
OtherApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
HTMLCheckResponse	hTMLCheckParams(String ID)	HTML check Returns the summary of the message HTML checker.
HTMLCheckResponse	hTMLCheckParams(String ID, Map<String,String> additionalHeaders)	HTML check Returns the summary of the message HTML checker.
<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.
LinkCheckResponse	linkCheckParams(String ID, String follow)	Link check Returns the summary of the message Link checker.
LinkCheckResponse	linkCheckParams(String ID, String follow, Map<String,String> additionalHeaders)	Link check Returns the summary of the message Link checker.
SpamAssassinResponse	spamAssassinCheckParams(String ID)	SpamAssassin check Returns the SpamAssassin summary (if enabled) of the message.
SpamAssassinResponse	spamAssassinCheckParams(String ID, Map<String,String> additionalHeaders)	SpamAssassin check Returns the SpamAssassin summary (if enabled) of the message.

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

OtherApi

public OtherApi()

OtherApi

public OtherApi(ApiClient apiClient)

Method Details

hTMLCheckParams

public HTMLCheckResponse hTMLCheckParams(@Nonnull
 String ID)
                                  throws ApiException

HTML check Returns the summary of the message HTML checker. The ID can be set to `latest` to return the latest message.

Parameters:

ID - Message database ID or \"latest\" (required)

Returns:

HTMLCheckResponse

Throws:

ApiException - if fails to make API call

hTMLCheckParams

public HTMLCheckResponse hTMLCheckParams(@Nonnull
 String ID,
 Map<String,String> additionalHeaders)
                                  throws ApiException

HTML check Returns the summary of the message HTML checker. The ID can be set to `latest` to return the latest message.

Parameters:

ID - Message database ID or \"latest\" (required)

additionalHeaders - additionalHeaders for this call

Returns:

HTMLCheckResponse

Throws:

ApiException - if fails to make API call

linkCheckParams

public LinkCheckResponse linkCheckParams(@Nonnull
 String ID,
 @Nullable
 String follow)
                                  throws ApiException

Link check Returns the summary of the message Link checker. The ID can be set to `latest` to return the latest message.

Parameters:

ID - Message database ID or \"latest\" (required)

follow - Follow redirects (optional, default to false)

Returns:

LinkCheckResponse

Throws:

ApiException - if fails to make API call

linkCheckParams

public LinkCheckResponse linkCheckParams(@Nonnull
 String ID,
 @Nullable
 String follow,
 Map<String,String> additionalHeaders)
                                  throws ApiException

Link check Returns the summary of the message Link checker. The ID can be set to `latest` to return the latest message.

Parameters:

ID - Message database ID or \"latest\" (required)

follow - Follow redirects (optional, default to false)

additionalHeaders - additionalHeaders for this call

Returns:

LinkCheckResponse

Throws:

ApiException - if fails to make API call

spamAssassinCheckParams

public SpamAssassinResponse spamAssassinCheckParams(@Nonnull
 String ID)
                                             throws ApiException

SpamAssassin check Returns the SpamAssassin summary (if enabled) of the message. The ID can be set to `latest` to return the latest message.

Parameters:

ID - Message database ID or \"latest\" (required)

Returns:

SpamAssassinResponse

Throws:

ApiException - if fails to make API call

spamAssassinCheckParams

public SpamAssassinResponse spamAssassinCheckParams(@Nonnull
 String ID,
 Map<String,String> additionalHeaders)
                                             throws ApiException

SpamAssassin check Returns the SpamAssassin summary (if enabled) of the message. The ID can be set to `latest` to return the latest message.

Parameters:

ID - Message database ID or \"latest\" (required)

additionalHeaders - additionalHeaders for this call

Returns:

SpamAssassinResponse

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.