com.mailslurp.apis

Class MissedEmailControllerApi

java.lang.Object

com.mailslurp.apis.MissedEmailControllerApi

public class MissedEmailControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MissedEmailControllerApi()
MissedEmailControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
PageMissedEmailProjection	getAllMissedEmails(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId) Get all MissedEmails in paginated format
okhttp3.Call	getAllMissedEmailsAsync(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId, ApiCallback<PageMissedEmailProjection> _callback) Get all MissedEmails in paginated format (asynchronously)
okhttp3.Call	getAllMissedEmailsCall(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId, ApiCallback _callback) Build call for getAllMissedEmails
ApiResponse<PageMissedEmailProjection>	getAllMissedEmailsWithHttpInfo(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId) Get all MissedEmails in paginated format
PageUnknownMissedEmailProjection	getAllUnknownMissedEmails(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId) Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
okhttp3.Call	getAllUnknownMissedEmailsAsync(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId, ApiCallback<PageUnknownMissedEmailProjection> _callback) Get all unknown missed emails in paginated format (asynchronously) Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
okhttp3.Call	getAllUnknownMissedEmailsCall(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId, ApiCallback _callback) Build call for getAllUnknownMissedEmails
ApiResponse<PageUnknownMissedEmailProjection>	getAllUnknownMissedEmailsWithHttpInfo(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId) Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
MissedEmailDto	getMissedEmail(UUID missedEmailId) Get MissedEmail List emails that were missed due to plan limits.
okhttp3.Call	getMissedEmailAsync(UUID missedEmailId, ApiCallback<MissedEmailDto> _callback) Get MissedEmail (asynchronously) List emails that were missed due to plan limits.
okhttp3.Call	getMissedEmailCall(UUID missedEmailId, ApiCallback _callback) Build call for getMissedEmail
ApiResponse<MissedEmailDto>	getMissedEmailWithHttpInfo(UUID missedEmailId) Get MissedEmail List emails that were missed due to plan limits.
void	restoreMissedEmails() Restore missed emails If emails were missed due to a plan limit they are saved as missed emails.
okhttp3.Call	restoreMissedEmailsAsync(ApiCallback<Void> _callback) Restore missed emails (asynchronously) If emails were missed due to a plan limit they are saved as missed emails.
okhttp3.Call	restoreMissedEmailsCall(ApiCallback _callback) Build call for restoreMissedEmails
ApiResponse<Void>	restoreMissedEmailsWithHttpInfo() Restore missed emails If emails were missed due to a plan limit they are saved as missed emails.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
MissedEmailDto	waitForNthMissedEmail(Integer index, UUID inboxId, Long timeout, OffsetDateTime since, OffsetDateTime before) Wait for Nth missed email Wait for 0 based index missed email
okhttp3.Call	waitForNthMissedEmailAsync(Integer index, UUID inboxId, Long timeout, OffsetDateTime since, OffsetDateTime before, ApiCallback<MissedEmailDto> _callback) Wait for Nth missed email (asynchronously) Wait for 0 based index missed email
okhttp3.Call	waitForNthMissedEmailCall(Integer index, UUID inboxId, Long timeout, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for waitForNthMissedEmail
ApiResponse<MissedEmailDto>	waitForNthMissedEmailWithHttpInfo(Integer index, UUID inboxId, Long timeout, OffsetDateTime since, OffsetDateTime before) Wait for Nth missed email Wait for 0 based index missed email

Methods inherited from class java.lang.Object

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

Constructor Detail

MissedEmailControllerApi

public MissedEmailControllerApi()

MissedEmailControllerApi

public MissedEmailControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getAllMissedEmailsCall

public okhttp3.Call getAllMissedEmailsCall(Integer page,
                                           Integer size,
                                           String sort,
                                           String searchFilter,
                                           OffsetDateTime since,
                                           OffsetDateTime before,
                                           UUID inboxId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getAllMissedEmails

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

inboxId - Optional inbox ID filter (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllMissedEmails

public PageMissedEmailProjection getAllMissedEmails(Integer page,
                                                    Integer size,
                                                    String sort,
                                                    String searchFilter,
                                                    OffsetDateTime since,
                                                    OffsetDateTime before,
                                                    UUID inboxId)
                                             throws ApiException

Get all MissedEmails in paginated format

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

inboxId - Optional inbox ID filter (optional)

Returns:

PageMissedEmailProjection

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllMissedEmailsWithHttpInfo

public ApiResponse<PageMissedEmailProjection> getAllMissedEmailsWithHttpInfo(Integer page,
                                                                             Integer size,
                                                                             String sort,
                                                                             String searchFilter,
                                                                             OffsetDateTime since,
                                                                             OffsetDateTime before,
                                                                             UUID inboxId)
                                                                      throws ApiException

Get all MissedEmails in paginated format

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

inboxId - Optional inbox ID filter (optional)

Returns:

ApiResponse<PageMissedEmailProjection>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllMissedEmailsAsync

public okhttp3.Call getAllMissedEmailsAsync(Integer page,
                                            Integer size,
                                            String sort,
                                            String searchFilter,
                                            OffsetDateTime since,
                                            OffsetDateTime before,
                                            UUID inboxId,
                                            ApiCallback<PageMissedEmailProjection> _callback)
                                     throws ApiException

Get all MissedEmails in paginated format (asynchronously)

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

inboxId - Optional inbox ID filter (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllUnknownMissedEmailsCall

public okhttp3.Call getAllUnknownMissedEmailsCall(Integer page,
                                                  Integer size,
                                                  String sort,
                                                  String searchFilter,
                                                  OffsetDateTime since,
                                                  OffsetDateTime before,
                                                  UUID inboxId,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getAllUnknownMissedEmails

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

inboxId - Optional inbox ID filter (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllUnknownMissedEmails

public PageUnknownMissedEmailProjection getAllUnknownMissedEmails(Integer page,
                                                                  Integer size,
                                                                  String sort,
                                                                  String searchFilter,
                                                                  OffsetDateTime since,
                                                                  OffsetDateTime before,
                                                                  UUID inboxId)
                                                           throws ApiException

Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

inboxId - Optional inbox ID filter (optional)

Returns:

PageUnknownMissedEmailProjection

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllUnknownMissedEmailsWithHttpInfo

public ApiResponse<PageUnknownMissedEmailProjection> getAllUnknownMissedEmailsWithHttpInfo(Integer page,
                                                                                           Integer size,
                                                                                           String sort,
                                                                                           String searchFilter,
                                                                                           OffsetDateTime since,
                                                                                           OffsetDateTime before,
                                                                                           UUID inboxId)
                                                                                    throws ApiException

Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

inboxId - Optional inbox ID filter (optional)

Returns:

ApiResponse<PageUnknownMissedEmailProjection>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getAllUnknownMissedEmailsAsync

public okhttp3.Call getAllUnknownMissedEmailsAsync(Integer page,
                                                   Integer size,
                                                   String sort,
                                                   String searchFilter,
                                                   OffsetDateTime since,
                                                   OffsetDateTime before,
                                                   UUID inboxId,
                                                   ApiCallback<PageUnknownMissedEmailProjection> _callback)
                                            throws ApiException

Get all unknown missed emails in paginated format (asynchronously) Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Parameters:

page - Optional page index in list pagination (optional, default to 0)

size - Optional page size in list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

inboxId - Optional inbox ID filter (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getMissedEmailCall

public okhttp3.Call getMissedEmailCall(UUID missedEmailId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getMissedEmail

Parameters:

missedEmailId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getMissedEmail

public MissedEmailDto getMissedEmail(UUID missedEmailId)
                              throws ApiException

Get MissedEmail List emails that were missed due to plan limits.

Parameters:

missedEmailId - (required)

Returns:

MissedEmailDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getMissedEmailWithHttpInfo

public ApiResponse<MissedEmailDto> getMissedEmailWithHttpInfo(UUID missedEmailId)
                                                       throws ApiException

Get MissedEmail List emails that were missed due to plan limits.

Parameters:

missedEmailId - (required)

Returns:

ApiResponse<MissedEmailDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getMissedEmailAsync

public okhttp3.Call getMissedEmailAsync(UUID missedEmailId,
                                        ApiCallback<MissedEmailDto> _callback)
                                 throws ApiException

Get MissedEmail (asynchronously) List emails that were missed due to plan limits.

Parameters:

missedEmailId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

restoreMissedEmailsCall

public okhttp3.Call restoreMissedEmailsCall(ApiCallback _callback)
                                     throws ApiException

Build call for restoreMissedEmails

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

restoreMissedEmails

public void restoreMissedEmails()
                         throws ApiException

Restore missed emails If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

restoreMissedEmailsWithHttpInfo

public ApiResponse<Void> restoreMissedEmailsWithHttpInfo()
                                                  throws ApiException

Restore missed emails If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

restoreMissedEmailsAsync

public okhttp3.Call restoreMissedEmailsAsync(ApiCallback<Void> _callback)
                                      throws ApiException

Restore missed emails (asynchronously) If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForNthMissedEmailCall

public okhttp3.Call waitForNthMissedEmailCall(Integer index,
                                              UUID inboxId,
                                              Long timeout,
                                              OffsetDateTime since,
                                              OffsetDateTime before,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for waitForNthMissedEmail

Parameters:

index - Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)

inboxId - Optional inbox ID filter (optional)

timeout - Optional timeout milliseconds (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForNthMissedEmail

public MissedEmailDto waitForNthMissedEmail(Integer index,
                                            UUID inboxId,
                                            Long timeout,
                                            OffsetDateTime since,
                                            OffsetDateTime before)
                                     throws ApiException

Wait for Nth missed email Wait for 0 based index missed email

Parameters:

index - Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)

inboxId - Optional inbox ID filter (optional)

timeout - Optional timeout milliseconds (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

MissedEmailDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForNthMissedEmailWithHttpInfo

public ApiResponse<MissedEmailDto> waitForNthMissedEmailWithHttpInfo(Integer index,
                                                                     UUID inboxId,
                                                                     Long timeout,
                                                                     OffsetDateTime since,
                                                                     OffsetDateTime before)
                                                              throws ApiException

Wait for Nth missed email Wait for 0 based index missed email

Parameters:

index - Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)

inboxId - Optional inbox ID filter (optional)

timeout - Optional timeout milliseconds (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<MissedEmailDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForNthMissedEmailAsync

public okhttp3.Call waitForNthMissedEmailAsync(Integer index,
                                               UUID inboxId,
                                               Long timeout,
                                               OffsetDateTime since,
                                               OffsetDateTime before,
                                               ApiCallback<MissedEmailDto> _callback)
                                        throws ApiException

Wait for Nth missed email (asynchronously) Wait for 0 based index missed email

Parameters:

index - Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)

inboxId - Optional inbox ID filter (optional)

timeout - Optional timeout milliseconds (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-