com.mailslurp.apis

Class ExpiredControllerApi

java.lang.Object

com.mailslurp.apis.ExpiredControllerApi

public class ExpiredControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ExpiredControllerApi()
ExpiredControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
ExpirationDefaults	getExpirationDefaults() Get default expiration settings Return default times used for inbox expiration
okhttp3.Call	getExpirationDefaultsAsync(ApiCallback<ExpirationDefaults> _callback) Get default expiration settings (asynchronously) Return default times used for inbox expiration
okhttp3.Call	getExpirationDefaultsCall(ApiCallback _callback) Build call for getExpirationDefaults
ApiResponse<ExpirationDefaults>	getExpirationDefaultsWithHttpInfo() Get default expiration settings Return default times used for inbox expiration
ExpiredInboxDto	getExpiredInboxByInboxId(UUID inboxId) Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired.
okhttp3.Call	getExpiredInboxByInboxIdAsync(UUID inboxId, ApiCallback<ExpiredInboxDto> _callback) Get expired inbox record for a previously existing inbox (asynchronously) Use the inboxId to return an ExpiredInboxRecord if an inbox has expired.
okhttp3.Call	getExpiredInboxByInboxIdCall(UUID inboxId, ApiCallback _callback) Build call for getExpiredInboxByInboxId
ApiResponse<ExpiredInboxDto>	getExpiredInboxByInboxIdWithHttpInfo(UUID inboxId) Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired.
PageExpiredInboxRecordProjection	getExpiredInboxes(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) List records of expired inboxes Inboxes created with an expiration date will expire after the given date.
okhttp3.Call	getExpiredInboxesAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageExpiredInboxRecordProjection> _callback) List records of expired inboxes (asynchronously) Inboxes created with an expiration date will expire after the given date.
okhttp3.Call	getExpiredInboxesCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getExpiredInboxes
ApiResponse<PageExpiredInboxRecordProjection>	getExpiredInboxesWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) List records of expired inboxes Inboxes created with an expiration date will expire after the given date.
ExpiredInboxDto	getExpiredInboxRecord(UUID expiredId) Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity.
okhttp3.Call	getExpiredInboxRecordAsync(UUID expiredId, ApiCallback<ExpiredInboxDto> _callback) Get an expired inbox record (asynchronously) Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity.
okhttp3.Call	getExpiredInboxRecordCall(UUID expiredId, ApiCallback _callback) Build call for getExpiredInboxRecord
ApiResponse<ExpiredInboxDto>	getExpiredInboxRecordWithHttpInfo(UUID expiredId) Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity.
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpiredControllerApi

public ExpiredControllerApi()

ExpiredControllerApi

public ExpiredControllerApi(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)

getExpirationDefaultsCall

public okhttp3.Call getExpirationDefaultsCall(ApiCallback _callback)
                                       throws ApiException

Build call for getExpirationDefaults

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	-

getExpirationDefaults

public ExpirationDefaults getExpirationDefaults()
                                         throws ApiException

Get default expiration settings Return default times used for inbox expiration

Returns:

ExpirationDefaults

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	-

getExpirationDefaultsWithHttpInfo

public ApiResponse<ExpirationDefaults> getExpirationDefaultsWithHttpInfo()
                                                                  throws ApiException

Get default expiration settings Return default times used for inbox expiration

Returns:

ApiResponse<ExpirationDefaults>

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	-

getExpirationDefaultsAsync

public okhttp3.Call getExpirationDefaultsAsync(ApiCallback<ExpirationDefaults> _callback)
                                        throws ApiException

Get default expiration settings (asynchronously) Return default times used for inbox expiration

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	-

getExpiredInboxByInboxIdCall

public okhttp3.Call getExpiredInboxByInboxIdCall(UUID inboxId,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for getExpiredInboxByInboxId

Parameters:

inboxId - ID of inbox you want to retrieve (not the inbox ID) (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	-

getExpiredInboxByInboxId

public ExpiredInboxDto getExpiredInboxByInboxId(UUID inboxId)
                                         throws ApiException

Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId

Parameters:

inboxId - ID of inbox you want to retrieve (not the inbox ID) (required)

Returns:

ExpiredInboxDto

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	-

getExpiredInboxByInboxIdWithHttpInfo

public ApiResponse<ExpiredInboxDto> getExpiredInboxByInboxIdWithHttpInfo(UUID inboxId)
                                                                  throws ApiException

Get expired inbox record for a previously existing inbox Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId

Parameters:

inboxId - ID of inbox you want to retrieve (not the inbox ID) (required)

Returns:

ApiResponse<ExpiredInboxDto>

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	-

getExpiredInboxByInboxIdAsync

public okhttp3.Call getExpiredInboxByInboxIdAsync(UUID inboxId,
                                                  ApiCallback<ExpiredInboxDto> _callback)
                                           throws ApiException

Get expired inbox record for a previously existing inbox (asynchronously) Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId

Parameters:

inboxId - ID of inbox you want to retrieve (not the inbox ID) (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	-

getExpiredInboxRecordCall

public okhttp3.Call getExpiredInboxRecordCall(UUID expiredId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getExpiredInboxRecord

Parameters:

expiredId - ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (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	-

getExpiredInboxRecord

public ExpiredInboxDto getExpiredInboxRecord(UUID expiredId)
                                      throws ApiException

Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties

Parameters:

expiredId - ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (required)

Returns:

ExpiredInboxDto

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	-

getExpiredInboxRecordWithHttpInfo

public ApiResponse<ExpiredInboxDto> getExpiredInboxRecordWithHttpInfo(UUID expiredId)
                                                               throws ApiException

Get an expired inbox record Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties

Parameters:

expiredId - ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (required)

Returns:

ApiResponse<ExpiredInboxDto>

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	-

getExpiredInboxRecordAsync

public okhttp3.Call getExpiredInboxRecordAsync(UUID expiredId,
                                               ApiCallback<ExpiredInboxDto> _callback)
                                        throws ApiException

Get an expired inbox record (asynchronously) Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties

Parameters:

expiredId - ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (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	-

getExpiredInboxesCall

public okhttp3.Call getExpiredInboxesCall(Integer page,
                                          Integer size,
                                          String sort,
                                          OffsetDateTime since,
                                          OffsetDateTime before,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getExpiredInboxes

Parameters:

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

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

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

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	-

getExpiredInboxes

public PageExpiredInboxRecordProjection getExpiredInboxes(Integer page,
                                                          Integer size,
                                                          String sort,
                                                          OffsetDateTime since,
                                                          OffsetDateTime before)
                                                   throws ApiException

List records of expired inboxes Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties

Parameters:

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

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

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

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

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

Returns:

PageExpiredInboxRecordProjection

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	-

getExpiredInboxesWithHttpInfo

public ApiResponse<PageExpiredInboxRecordProjection> getExpiredInboxesWithHttpInfo(Integer page,
                                                                                   Integer size,
                                                                                   String sort,
                                                                                   OffsetDateTime since,
                                                                                   OffsetDateTime before)
                                                                            throws ApiException

List records of expired inboxes Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties

Parameters:

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

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

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

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

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

Returns:

ApiResponse<PageExpiredInboxRecordProjection>

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	-

getExpiredInboxesAsync

public okhttp3.Call getExpiredInboxesAsync(Integer page,
                                           Integer size,
                                           String sort,
                                           OffsetDateTime since,
                                           OffsetDateTime before,
                                           ApiCallback<PageExpiredInboxRecordProjection> _callback)
                                    throws ApiException

List records of expired inboxes (asynchronously) Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties

Parameters:

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

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

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

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	-