Uses of Class
software.xdev.mailpit.client.ApiException

Packages that use ApiException

Package	Description
software.xdev.mailpit.api
software.xdev.mailpit.client

Uses of ApiException in software.xdev.mailpit.api

Methods in software.xdev.mailpit.api that throw ApiException

Modifier and Type	Method	Description
AppInformation	ApplicationApi.appInformation()	Get application information Returns basic runtime information, message totals and latest release version.
AppInformation	ApplicationApi.appInformation(Map<String,String> additionalHeaders)	Get application information Returns basic runtime information, message totals and latest release version.
String	MessageApi.attachmentParams(String ID, String partID)	Get message attachment This will return the attachment part using the appropriate Content-Type.
String	MessageApi.attachmentParams(String ID, String partID, Map<String,String> additionalHeaders)	Get message attachment This will return the attachment part using the appropriate Content-Type.
String	MessagesApi.deleteMessagesParams(DeleteMessagesParamsRequest body)	Delete messages Delete individual or all messages.
String	MessagesApi.deleteMessagesParams(DeleteMessagesParamsRequest body, Map<String,String> additionalHeaders)	Delete messages Delete individual or all messages.
String	MessagesApi.deleteSearchParams(String query, String tz)	Delete messages by search Delete all messages matching [a search](https://mailpit.axllent.org/docs/usage/search-filters/).
String	MessagesApi.deleteSearchParams(String query, String tz, Map<String,String> additionalHeaders)	Delete messages by search Delete all messages matching [a search](https://mailpit.axllent.org/docs/usage/search-filters/).
String	TagsApi.deleteTagParams(String tag)	Delete a tag Deletes a tag.
String	TagsApi.deleteTagParams(String tag, Map<String,String> additionalHeaders)	Delete a tag Deletes a tag.
String	MessageApi.downloadRawParams(String ID)	Get message source Returns the full email source as plain text.
String	MessageApi.downloadRawParams(String ID, Map<String,String> additionalHeaders)	Get message source Returns the full email source as plain text.
List<String>	TagsApi.getAllTags()	Get all current tags Returns a JSON array of all unique message tags.
List<String>	TagsApi.getAllTags(Map<String,String> additionalHeaders)	Get all current tags Returns a JSON array of all unique message tags.
ChaosTriggers	TestingApi.getChaos()	Get Chaos triggers Returns the current Chaos triggers configuration.
ChaosTriggers	TestingApi.getChaos(Map<String,String> additionalHeaders)	Get Chaos triggers Returns the current Chaos triggers configuration.
Map<String,List<String>>	MessageApi.getHeadersParams(String ID)	Get message headers Returns the message headers as an array.
Map<String,List<String>>	MessageApi.getHeadersParams(String ID, Map<String,String> additionalHeaders)	Get message headers Returns the message headers as an array.
String	TestingApi.getMessageHTMLParams(String ID, String embed)	Render message HTML part Renders just the message's HTML part which can be used for UI integration testing.
String	TestingApi.getMessageHTMLParams(String ID, String embed, Map<String,String> additionalHeaders)	Render message HTML part Renders just the message's HTML part which can be used for UI integration testing.
Message	MessageApi.getMessageParams(String ID)	Get message summary Returns the summary of a message, marking the message as read.
Message	MessageApi.getMessageParams(String ID, Map<String,String> additionalHeaders)	Get message summary Returns the summary of a message, marking the message as read.
MessagesSummary	MessagesApi.getMessagesParams(Long start, Long limit)	List messages Returns messages from the mailbox ordered from newest to oldest.
MessagesSummary	MessagesApi.getMessagesParams(Long start, Long limit, Map<String,String> additionalHeaders)	List messages Returns messages from the mailbox ordered from newest to oldest.
String	TestingApi.getMessageTextParams(String ID)	Render message text part Renders just the message's text part which can be used for UI integration testing.
String	TestingApi.getMessageTextParams(String ID, Map<String,String> additionalHeaders)	Render message text part Renders just the message's text part which can be used for UI integration testing.
HTMLCheckResponse	OtherApi.hTMLCheckParams(String ID)	HTML check Returns the summary of the message HTML checker.
HTMLCheckResponse	OtherApi.hTMLCheckParams(String ID, Map<String,String> additionalHeaders)	HTML check Returns the summary of the message HTML checker.
<T> T	ApplicationApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)
<T> T	MessageApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)
<T> T	MessagesApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)
<T> T	OtherApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)
<T> T	TagsApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)
<T> T	TestingApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)
LinkCheckResponse	OtherApi.linkCheckParams(String ID, String follow)	Link check Returns the summary of the message Link checker.
LinkCheckResponse	OtherApi.linkCheckParams(String ID, String follow, Map<String,String> additionalHeaders)	Link check Returns the summary of the message Link checker.
String	MessageApi.releaseMessageParams(String ID, ReleaseMessageParamsRequest body)	Release message Release a message via a pre-configured external SMTP server.
String	MessageApi.releaseMessageParams(String ID, ReleaseMessageParamsRequest body, Map<String,String> additionalHeaders)	Release message Release a message via a pre-configured external SMTP server.
String	TagsApi.renameTagParams(String tag, RenameTagParamsRequest body)	Rename a tag Renames an existing tag.
String	TagsApi.renameTagParams(String tag, RenameTagParamsRequest body, Map<String,String> additionalHeaders)	Rename a tag Renames an existing tag.
MessagesSummary	MessagesApi.searchParams(String query, String start, String limit, String tz)	Search messages Returns messages matching [a search](https://mailpit.axllent.org/docs/usage/search-filters/), sorted by received date (descending).
MessagesSummary	MessagesApi.searchParams(String query, String start, String limit, String tz, Map<String,String> additionalHeaders)	Search messages Returns messages matching [a search](https://mailpit.axllent.org/docs/usage/search-filters/), sorted by received date (descending).
SendMessageParams200Response	MessageApi.sendMessageParams(SendMessageParamsRequest body)	Send a message Send a message via the HTTP API.
SendMessageParams200Response	MessageApi.sendMessageParams(SendMessageParamsRequest body, Map<String,String> additionalHeaders)	Send a message Send a message via the HTTP API.
ChaosTriggers	TestingApi.setChaosParams(ChaosTriggers body)	Set Chaos triggers Set the Chaos triggers configuration and return the updated values.
ChaosTriggers	TestingApi.setChaosParams(ChaosTriggers body, Map<String,String> additionalHeaders)	Set Chaos triggers Set the Chaos triggers configuration and return the updated values.
String	MessagesApi.setReadStatusParams(String tz, SetReadStatusParamsRequest body)	Set read status You can optionally provide an array of IDs or a search string.
String	MessagesApi.setReadStatusParams(String tz, SetReadStatusParamsRequest body, Map<String,String> additionalHeaders)	Set read status You can optionally provide an array of IDs or a search string.
String	TagsApi.setTagsParams(SetTagsParamsRequest body)	Set message tags This will overwrite any existing tags for selected message database IDs.
String	TagsApi.setTagsParams(SetTagsParamsRequest body, Map<String,String> additionalHeaders)	Set message tags This will overwrite any existing tags for selected message database IDs.
SpamAssassinResponse	OtherApi.spamAssassinCheckParams(String ID)	SpamAssassin check Returns the SpamAssassin summary (if enabled) of the message.
SpamAssassinResponse	OtherApi.spamAssassinCheckParams(String ID, Map<String,String> additionalHeaders)	SpamAssassin check Returns the SpamAssassin summary (if enabled) of the message.
String	MessageApi.thumbnailParams(String ID, String partID)	Get an attachment image thumbnail This will return a cropped 180x120 JPEG thumbnail of an image attachment.
String	MessageApi.thumbnailParams(String ID, String partID, Map<String,String> additionalHeaders)	Get an attachment image thumbnail This will return a cropped 180x120 JPEG thumbnail of an image attachment.
WebUIConfigurationResponse200Response	ApplicationApi.webUIConfigurationResponse()	Get web UI configuration Returns configuration settings for the web UI.
WebUIConfigurationResponse200Response	ApplicationApi.webUIConfigurationResponse(Map<String,String> additionalHeaders)	Get web UI configuration Returns configuration settings for the web UI.

Uses of ApiException in software.xdev.mailpit.client

Methods in software.xdev.mailpit.client that throw ApiException

Modifier and Type	Method	Description
<T> T	ApiClient.deserialize(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> valueType)	Deserialize response body to Java object according to the Content-Type.
protected org.apache.hc.core5.http.ContentType	ApiClient.getContentType(String headerValue)	Parse content type object from header value
protected String	ApiClient.getResponseMimeType(org.apache.hc.core5.http.HttpResponse response)	Get content type of a response or null if one was not provided
<T> T	ApiClient.invokeAPI(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, String urlQueryDeepObject, Object body, Map<String,String> headerParams, Map<String,String> cookieParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames, com.fasterxml.jackson.core.type.TypeReference<T> returnType)	Invoke API by sending HTTP request with the given options.
void	BaseApi.invokeAPI(String url, String method)	Directly invoke the API for the given URL.
<T> T	BaseApi.invokeAPI(String url, String method, com.fasterxml.jackson.core.type.TypeReference<T> returnType)	Directly invoke the API for the given URL.
void	BaseApi.invokeAPI(String url, String method, Object request)	Directly invoke the API for the given URL.
<T> T	BaseApi.invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType)	Directly invoke the API for the given URL.
abstract <T> T	BaseApi.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.
void	BaseApi.invokeAPI(String url, String method, Object request, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.
void	BaseApi.invokeAPI(String url, String method, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.
protected <T> T	ApiClient.processResponse(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> returnType)
org.apache.hc.core5.http.HttpEntity	ApiClient.serialize(Object obj, Map<String,Object> formParams, org.apache.hc.core5.http.ContentType contentType)	Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).