Package io.quarkiverse.mailpit.test.rest

Class MessagesApi

java.lang.Object

io.quarkiverse.mailpit.test.rest.MessagesApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class MessagesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MessagesApi()
MessagesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	delete(DeleteRequest ids)	Delete messages If no IDs are provided then all messages are deleted.
ApiResponse<Void>	deleteWithHttpInfo(DeleteRequest ids)	Delete messages If no IDs are provided then all messages are deleted.
protected ApiException	getApiException(String operationId, HttpResponse<InputStream> response)
MessagesSummary	getMessages(Integer start, Integer limit)	List messages Returns messages from the mailbox ordered from newest to oldest.
ApiResponse<MessagesSummary>	getMessagesWithHttpInfo(Integer start, Integer limit)	List messages Returns messages from the mailbox ordered from newest to oldest.
MessagesSummary	messagesSummary(String query, Integer start, Integer limit)	Search messages Returns the latest messages matching a search.
void	messagesSummary_0(String query)	Delete messages by search Deletes messages matching a search.
ApiResponse<Void>	messagesSummary_0WithHttpInfo(String query)	Delete messages by search Deletes messages matching a search.
ApiResponse<MessagesSummary>	messagesSummaryWithHttpInfo(String query, Integer start, Integer limit)	Search messages Returns the latest messages matching a search.
void	setReadStatus(SetReadStatusRequest ids)	Set read status If no IDs are provided then all messages are updated.
ApiResponse<Void>	setReadStatusWithHttpInfo(SetReadStatusRequest ids)	Set read status If no IDs are provided then all messages are updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesApi

public MessagesApi()

MessagesApi

public MessagesApi(ApiClient apiClient)

Method Detail

getApiException

protected ApiException getApiException(String operationId,
                                       HttpResponse<InputStream> response)
                                throws IOException

Throws:

IOException

delete

public void delete(DeleteRequest ids)
            throws ApiException

Delete messages If no IDs are provided then all messages are deleted.

Parameters:

ids - Database IDs to delete (optional)

Throws:

ApiException - if fails to make API call

deleteWithHttpInfo

public ApiResponse<Void> deleteWithHttpInfo(DeleteRequest ids)
                                     throws ApiException

Delete messages If no IDs are provided then all messages are deleted.

Parameters:

ids - Database IDs to delete (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

getMessages

public MessagesSummary getMessages(Integer start,
                                   Integer limit)
                            throws ApiException

List messages Returns messages from the mailbox ordered from newest to oldest.

Parameters:

start - Pagination offset (optional, default to 0)

limit - Limit results (optional, default to 50)

Returns:

MessagesSummary

Throws:

ApiException - if fails to make API call

getMessagesWithHttpInfo

public ApiResponse<MessagesSummary> getMessagesWithHttpInfo(Integer start,
                                                            Integer limit)
                                                     throws ApiException

List messages Returns messages from the mailbox ordered from newest to oldest.

Parameters:

start - Pagination offset (optional, default to 0)

limit - Limit results (optional, default to 50)

Returns:

ApiResponse<MessagesSummary>

Throws:

ApiException - if fails to make API call

messagesSummary

public MessagesSummary messagesSummary(String query,
                                       Integer start,
                                       Integer limit)
                                throws ApiException

Search messages Returns the latest messages matching a search.

Parameters:

query - Search query (required)

start - Pagination offset (optional, default to 0)

limit - Limit results (optional, default to 50)

Returns:

MessagesSummary

Throws:

ApiException - if fails to make API call

messagesSummaryWithHttpInfo

public ApiResponse<MessagesSummary> messagesSummaryWithHttpInfo(String query,
                                                                Integer start,
                                                                Integer limit)
                                                         throws ApiException

Search messages Returns the latest messages matching a search.

Parameters:

query - Search query (required)

start - Pagination offset (optional, default to 0)

limit - Limit results (optional, default to 50)

Returns:

ApiResponse<MessagesSummary>

Throws:

ApiException - if fails to make API call

messagesSummary_0

public void messagesSummary_0(String query)
                       throws ApiException

Delete messages by search Deletes messages matching a search.

Parameters:

query - Search query (required)

Throws:

ApiException - if fails to make API call

messagesSummary_0WithHttpInfo

public ApiResponse<Void> messagesSummary_0WithHttpInfo(String query)
                                                throws ApiException

Delete messages by search Deletes messages matching a search.

Parameters:

query - Search query (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

setReadStatus

public void setReadStatus(SetReadStatusRequest ids)
                   throws ApiException

Set read status If no IDs are provided then all messages are updated.

Parameters:

ids - Database IDs to update (optional)

Throws:

ApiException - if fails to make API call

setReadStatusWithHttpInfo

public ApiResponse<Void> setReadStatusWithHttpInfo(SetReadStatusRequest ids)
                                            throws ApiException

Set read status If no IDs are provided then all messages are updated.

Parameters:

ids - Database IDs to update (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call