public class ExpiredControllerApi extends Object
| Constructor and Description |
|---|
ExpiredControllerApi() |
ExpiredControllerApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
ApiClient |
getApiClient() |
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)
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,
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,
ApiCallback _callback)
Build call for getExpiredInboxes
|
ApiResponse<PageExpiredInboxRecordProjection> |
getExpiredInboxesWithHttpInfo(Integer page,
Integer size,
String sort)
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.
|
void |
setApiClient(ApiClient apiClient) |
public ExpiredControllerApi()
public ExpiredControllerApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call getExpirationDefaultsCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ExpirationDefaults getExpirationDefaults() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<ExpirationDefaults> getExpirationDefaultsWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getExpirationDefaultsAsync(ApiCallback<ExpirationDefaults> _callback) throws ApiException
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getExpiredInboxByInboxIdCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - ID of inbox you want to retrieve (not the inbox ID) (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ExpiredInboxDto getExpiredInboxByInboxId(UUID inboxId) throws ApiException
inboxId - ID of inbox you want to retrieve (not the inbox ID) (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<ExpiredInboxDto> getExpiredInboxByInboxIdWithHttpInfo(UUID inboxId) throws ApiException
inboxId - ID of inbox you want to retrieve (not the inbox ID) (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getExpiredInboxByInboxIdAsync(UUID inboxId, ApiCallback<ExpiredInboxDto> _callback) throws ApiException
inboxId - ID of inbox you want to retrieve (not the inbox ID) (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getExpiredInboxRecordCall(UUID expiredId, ApiCallback _callback) throws ApiException
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 progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ExpiredInboxDto getExpiredInboxRecord(UUID expiredId) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<ExpiredInboxDto> getExpiredInboxRecordWithHttpInfo(UUID expiredId) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getExpiredInboxRecordAsync(UUID expiredId, ApiCallback<ExpiredInboxDto> _callback) throws ApiException
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getExpiredInboxesCall(Integer page, Integer size, String sort, ApiCallback _callback) throws ApiException
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)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public PageExpiredInboxRecordProjection getExpiredInboxes(Integer page, Integer size, String sort) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<PageExpiredInboxRecordProjection> getExpiredInboxesWithHttpInfo(Integer page, Integer size, String sort) throws ApiException
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getExpiredInboxesAsync(Integer page, Integer size, String sort, ApiCallback<PageExpiredInboxRecordProjection> _callback) throws ApiException
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)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
Copyright © 2021. All rights reserved.