public class InboxControllerApi extends Object
| Constructor and Description |
|---|
InboxControllerApi() |
InboxControllerApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
Inbox |
createInbox(Boolean allowTeamAccess,
String description,
String emailAddress,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean favourite,
String name,
List<String> tags,
Boolean useDomainPool)
Create an Inbox (email address)
Create a new inbox and with a randomized email address to send and receive from.
|
okhttp3.Call |
createInboxAsync(Boolean allowTeamAccess,
String description,
String emailAddress,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean favourite,
String name,
List<String> tags,
Boolean useDomainPool,
ApiCallback<Inbox> _callback)
Create an Inbox (email address) (asynchronously)
Create a new inbox and with a randomized email address to send and receive from.
|
okhttp3.Call |
createInboxCall(Boolean allowTeamAccess,
String description,
String emailAddress,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean favourite,
String name,
List<String> tags,
Boolean useDomainPool,
ApiCallback _callback)
Build call for createInbox
|
ApiResponse<Inbox> |
createInboxWithHttpInfo(Boolean allowTeamAccess,
String description,
String emailAddress,
OffsetDateTime expiresAt,
Long expiresIn,
Boolean favourite,
String name,
List<String> tags,
Boolean useDomainPool)
Create an Inbox (email address)
Create a new inbox and with a randomized email address to send and receive from.
|
Inbox |
createInboxWithOptions(CreateInboxDto createInboxDto)
Create an inbox with additional options
Additional endpoint that allows inbox creation with request body options.
|
okhttp3.Call |
createInboxWithOptionsAsync(CreateInboxDto createInboxDto,
ApiCallback<Inbox> _callback)
Create an inbox with additional options (asynchronously)
Additional endpoint that allows inbox creation with request body options.
|
okhttp3.Call |
createInboxWithOptionsCall(CreateInboxDto createInboxDto,
ApiCallback _callback)
Build call for createInboxWithOptions
|
ApiResponse<Inbox> |
createInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto)
Create an inbox with additional options
Additional endpoint that allows inbox creation with request body options.
|
void |
deleteAllInboxes()
Delete all inboxes
Permanently delete all inboxes and associated email addresses.
|
okhttp3.Call |
deleteAllInboxesAsync(ApiCallback<Void> _callback)
Delete all inboxes (asynchronously)
Permanently delete all inboxes and associated email addresses.
|
okhttp3.Call |
deleteAllInboxesCall(ApiCallback _callback)
Build call for deleteAllInboxes
|
ApiResponse<Void> |
deleteAllInboxesWithHttpInfo()
Delete all inboxes
Permanently delete all inboxes and associated email addresses.
|
void |
deleteInbox(UUID inboxId)
Delete inbox
Permanently delete an inbox and associated email address as well as all emails within the given inbox.
|
okhttp3.Call |
deleteInboxAsync(UUID inboxId,
ApiCallback<Void> _callback)
Delete inbox (asynchronously)
Permanently delete an inbox and associated email address as well as all emails within the given inbox.
|
okhttp3.Call |
deleteInboxCall(UUID inboxId,
ApiCallback _callback)
Build call for deleteInbox
|
ApiResponse<Void> |
deleteInboxWithHttpInfo(UUID inboxId)
Delete inbox
Permanently delete an inbox and associated email address as well as all emails within the given inbox.
|
PageInboxProjection |
getAllInboxes(Boolean favourite,
Integer page,
String search,
Integer size,
String sort,
String tag,
Boolean teamAccess)
List All Inboxes Paginated
List inboxes in paginated form.
|
okhttp3.Call |
getAllInboxesAsync(Boolean favourite,
Integer page,
String search,
Integer size,
String sort,
String tag,
Boolean teamAccess,
ApiCallback<PageInboxProjection> _callback)
List All Inboxes Paginated (asynchronously)
List inboxes in paginated form.
|
okhttp3.Call |
getAllInboxesCall(Boolean favourite,
Integer page,
String search,
Integer size,
String sort,
String tag,
Boolean teamAccess,
ApiCallback _callback)
Build call for getAllInboxes
|
ApiResponse<PageInboxProjection> |
getAllInboxesWithHttpInfo(Boolean favourite,
Integer page,
String search,
Integer size,
String sort,
String tag,
Boolean teamAccess)
List All Inboxes Paginated
List inboxes in paginated form.
|
ApiClient |
getApiClient() |
List<EmailPreview> |
getEmails(UUID inboxId,
Integer limit,
Long minCount,
Long retryTimeout,
OffsetDateTime since,
Integer size,
String sort)
Get emails in an Inbox.
|
okhttp3.Call |
getEmailsAsync(UUID inboxId,
Integer limit,
Long minCount,
Long retryTimeout,
OffsetDateTime since,
Integer size,
String sort,
ApiCallback<List<EmailPreview>> _callback)
Get emails in an Inbox.
|
okhttp3.Call |
getEmailsCall(UUID inboxId,
Integer limit,
Long minCount,
Long retryTimeout,
OffsetDateTime since,
Integer size,
String sort,
ApiCallback _callback)
Build call for getEmails
|
ApiResponse<List<EmailPreview>> |
getEmailsWithHttpInfo(UUID inboxId,
Integer limit,
Long minCount,
Long retryTimeout,
OffsetDateTime since,
Integer size,
String sort)
Get emails in an Inbox.
|
Inbox |
getInbox(UUID inboxId)
Get Inbox
Returns an inbox's properties, including its email address and ID.
|
okhttp3.Call |
getInboxAsync(UUID inboxId,
ApiCallback<Inbox> _callback)
Get Inbox (asynchronously)
Returns an inbox's properties, including its email address and ID.
|
okhttp3.Call |
getInboxCall(UUID inboxId,
ApiCallback _callback)
Build call for getInbox
|
PageEmailPreview |
getInboxEmailsPaginated(UUID inboxId,
Integer page,
Integer size,
String sort)
Get inbox emails paginated
Get a paginated list of emails in an inbox.
|
okhttp3.Call |
getInboxEmailsPaginatedAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback<PageEmailPreview> _callback)
Get inbox emails paginated (asynchronously)
Get a paginated list of emails in an inbox.
|
okhttp3.Call |
getInboxEmailsPaginatedCall(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getInboxEmailsPaginated
|
ApiResponse<PageEmailPreview> |
getInboxEmailsPaginatedWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort)
Get inbox emails paginated
Get a paginated list of emails in an inbox.
|
List<Inbox> |
getInboxes(Integer size,
String sort)
List Inboxes / Email Addresses
List the inboxes you have created.
|
okhttp3.Call |
getInboxesAsync(Integer size,
String sort,
ApiCallback<List<Inbox>> _callback)
List Inboxes / Email Addresses (asynchronously)
List the inboxes you have created.
|
okhttp3.Call |
getInboxesCall(Integer size,
String sort,
ApiCallback _callback)
Build call for getInboxes
|
ApiResponse<List<Inbox>> |
getInboxesWithHttpInfo(Integer size,
String sort)
List Inboxes / Email Addresses
List the inboxes you have created.
|
PageSentEmailProjection |
getInboxSentEmails(UUID inboxId,
Integer page,
Integer size,
String sort)
Get Inbox Sent Emails
Returns an inbox's sent email receipts.
|
okhttp3.Call |
getInboxSentEmailsAsync(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback<PageSentEmailProjection> _callback)
Get Inbox Sent Emails (asynchronously)
Returns an inbox's sent email receipts.
|
okhttp3.Call |
getInboxSentEmailsCall(UUID inboxId,
Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getInboxSentEmails
|
ApiResponse<PageSentEmailProjection> |
getInboxSentEmailsWithHttpInfo(UUID inboxId,
Integer page,
Integer size,
String sort)
Get Inbox Sent Emails
Returns an inbox's sent email receipts.
|
List<String> |
getInboxTags()
Get inbox tags
Get all inbox tags
|
okhttp3.Call |
getInboxTagsAsync(ApiCallback<List<String>> _callback)
Get inbox tags (asynchronously)
Get all inbox tags
|
okhttp3.Call |
getInboxTagsCall(ApiCallback _callback)
Build call for getInboxTags
|
ApiResponse<List<String>> |
getInboxTagsWithHttpInfo()
Get inbox tags
Get all inbox tags
|
ApiResponse<Inbox> |
getInboxWithHttpInfo(UUID inboxId)
Get Inbox
Returns an inbox's properties, including its email address and ID.
|
PageOrganizationInboxProjection |
getOrganizationInboxes(Integer page,
Integer size,
String sort)
List Organization Inboxes Paginated
List organization inboxes in paginated form.
|
okhttp3.Call |
getOrganizationInboxesAsync(Integer page,
Integer size,
String sort,
ApiCallback<PageOrganizationInboxProjection> _callback)
List Organization Inboxes Paginated (asynchronously)
List organization inboxes in paginated form.
|
okhttp3.Call |
getOrganizationInboxesCall(Integer page,
Integer size,
String sort,
ApiCallback _callback)
Build call for getOrganizationInboxes
|
ApiResponse<PageOrganizationInboxProjection> |
getOrganizationInboxesWithHttpInfo(Integer page,
Integer size,
String sort)
List Organization Inboxes Paginated
List organization inboxes in paginated form.
|
void |
sendEmail(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send Email
Send an email from an inbox's email address.
|
SentEmailDto |
sendEmailAndConfirm(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send email and return sent confirmation
Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
|
okhttp3.Call |
sendEmailAndConfirmAsync(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback<SentEmailDto> _callback)
Send email and return sent confirmation (asynchronously)
Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
|
okhttp3.Call |
sendEmailAndConfirmCall(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback _callback)
Build call for sendEmailAndConfirm
|
ApiResponse<SentEmailDto> |
sendEmailAndConfirmWithHttpInfo(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send email and return sent confirmation
Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
|
okhttp3.Call |
sendEmailAsync(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback<Void> _callback)
Send Email (asynchronously)
Send an email from an inbox's email address.
|
okhttp3.Call |
sendEmailCall(UUID inboxId,
SendEmailOptions sendEmailOptions,
ApiCallback _callback)
Build call for sendEmail
|
ApiResponse<Void> |
sendEmailWithHttpInfo(UUID inboxId,
SendEmailOptions sendEmailOptions)
Send Email
Send an email from an inbox's email address.
|
void |
setApiClient(ApiClient apiClient) |
Inbox |
setInboxFavourited(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions)
Set inbox favourited state
Set and return new favourite state for an inbox
|
okhttp3.Call |
setInboxFavouritedAsync(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions,
ApiCallback<Inbox> _callback)
Set inbox favourited state (asynchronously)
Set and return new favourite state for an inbox
|
okhttp3.Call |
setInboxFavouritedCall(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions,
ApiCallback _callback)
Build call for setInboxFavourited
|
ApiResponse<Inbox> |
setInboxFavouritedWithHttpInfo(UUID inboxId,
SetInboxFavouritedOptions setInboxFavouritedOptions)
Set inbox favourited state
Set and return new favourite state for an inbox
|
Inbox |
updateInbox(UUID inboxId,
UpdateInboxOptions updateInboxOptions)
Update Inbox
Update editable fields on an inbox
|
okhttp3.Call |
updateInboxAsync(UUID inboxId,
UpdateInboxOptions updateInboxOptions,
ApiCallback<Inbox> _callback)
Update Inbox (asynchronously)
Update editable fields on an inbox
|
okhttp3.Call |
updateInboxCall(UUID inboxId,
UpdateInboxOptions updateInboxOptions,
ApiCallback _callback)
Build call for updateInbox
|
ApiResponse<Inbox> |
updateInboxWithHttpInfo(UUID inboxId,
UpdateInboxOptions updateInboxOptions)
Update Inbox
Update editable fields on an inbox
|
public InboxControllerApi()
public InboxControllerApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call createInboxCall(Boolean allowTeamAccess, String description, String emailAddress, OffsetDateTime expiresAt, Long expiresIn, Boolean favourite, String name, List<String> tags, Boolean useDomainPool, ApiCallback _callback) throws ApiException
allowTeamAccess - Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)description - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)emailAddress - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)expiresAt - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)expiresIn - Number of milliseconds that inbox should exist for (optional)favourite - Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering (optional)name - Optional name of the inbox. Displayed in the dashboard for easier search (optional)tags - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)useDomainPool - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public Inbox createInbox(Boolean allowTeamAccess, String description, String emailAddress, OffsetDateTime expiresAt, Long expiresIn, Boolean favourite, String name, List<String> tags, Boolean useDomainPool) throws ApiException
allowTeamAccess - Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)description - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)emailAddress - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)expiresAt - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)expiresIn - Number of milliseconds that inbox should exist for (optional)favourite - Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering (optional)name - Optional name of the inbox. Displayed in the dashboard for easier search (optional)tags - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)useDomainPool - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<Inbox> createInboxWithHttpInfo(Boolean allowTeamAccess, String description, String emailAddress, OffsetDateTime expiresAt, Long expiresIn, Boolean favourite, String name, List<String> tags, Boolean useDomainPool) throws ApiException
allowTeamAccess - Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)description - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)emailAddress - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)expiresAt - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)expiresIn - Number of milliseconds that inbox should exist for (optional)favourite - Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering (optional)name - Optional name of the inbox. Displayed in the dashboard for easier search (optional)tags - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)useDomainPool - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call createInboxAsync(Boolean allowTeamAccess, String description, String emailAddress, OffsetDateTime expiresAt, Long expiresIn, Boolean favourite, String name, List<String> tags, Boolean useDomainPool, ApiCallback<Inbox> _callback) throws ApiException
allowTeamAccess - Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)description - Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)emailAddress - A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID. (optional)expiresAt - Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)expiresIn - Number of milliseconds that inbox should exist for (optional)favourite - Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering (optional)name - Optional name of the inbox. Displayed in the dashboard for easier search (optional)tags - Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI. (optional)useDomainPool - Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. (optional)_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 |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call createInboxWithOptionsCall(CreateInboxDto createInboxDto, ApiCallback _callback) throws ApiException
createInboxDto - createInboxDto (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public Inbox createInboxWithOptions(CreateInboxDto createInboxDto) throws ApiException
createInboxDto - createInboxDto (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<Inbox> createInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto) throws ApiException
createInboxDto - createInboxDto (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call createInboxWithOptionsAsync(CreateInboxDto createInboxDto, ApiCallback<Inbox> _callback) throws ApiException
createInboxDto - createInboxDto (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 |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call deleteAllInboxesCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public void deleteAllInboxes()
throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public ApiResponse<Void> deleteAllInboxesWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call deleteAllInboxesAsync(ApiCallback<Void> _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 |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call deleteInboxCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - inboxId (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public void deleteInbox(UUID inboxId) throws ApiException
inboxId - inboxId (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public ApiResponse<Void> deleteInboxWithHttpInfo(UUID inboxId) throws ApiException
inboxId - inboxId (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call deleteInboxAsync(UUID inboxId, ApiCallback<Void> _callback) throws ApiException
inboxId - 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 |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call getAllInboxesCall(Boolean favourite, Integer page, String search, Integer size, String sort, String tag, Boolean teamAccess, ApiCallback _callback) throws ApiException
favourite - Optionally filter results for favourites only (optional, default to false)page - Optional page index in inbox list pagination (optional, default to 0)search - Optionally filter by search words partial matching ID, tags, name, and email address (optional)size - Optional page size in inbox list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)tag - Optionally filter by tags. Will return inboxes that include given tags (optional)teamAccess - Optionally filter by team access. Defaults to false so organization inboxes are not included (optional, default to false)_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 PageInboxProjection getAllInboxes(Boolean favourite, Integer page, String search, Integer size, String sort, String tag, Boolean teamAccess) throws ApiException
favourite - Optionally filter results for favourites only (optional, default to false)page - Optional page index in inbox list pagination (optional, default to 0)search - Optionally filter by search words partial matching ID, tags, name, and email address (optional)size - Optional page size in inbox list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)tag - Optionally filter by tags. Will return inboxes that include given tags (optional)teamAccess - Optionally filter by team access. Defaults to false so organization inboxes are not included (optional, default to false)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<PageInboxProjection> getAllInboxesWithHttpInfo(Boolean favourite, Integer page, String search, Integer size, String sort, String tag, Boolean teamAccess) throws ApiException
favourite - Optionally filter results for favourites only (optional, default to false)page - Optional page index in inbox list pagination (optional, default to 0)search - Optionally filter by search words partial matching ID, tags, name, and email address (optional)size - Optional page size in inbox list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)tag - Optionally filter by tags. Will return inboxes that include given tags (optional)teamAccess - Optionally filter by team access. Defaults to false so organization inboxes are not included (optional, default to false)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 getAllInboxesAsync(Boolean favourite, Integer page, String search, Integer size, String sort, String tag, Boolean teamAccess, ApiCallback<PageInboxProjection> _callback) throws ApiException
favourite - Optionally filter results for favourites only (optional, default to false)page - Optional page index in inbox list pagination (optional, default to 0)search - Optionally filter by search words partial matching ID, tags, name, and email address (optional)size - Optional page size in inbox list pagination (optional, default to 20)sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)tag - Optionally filter by tags. Will return inboxes that include given tags (optional)teamAccess - Optionally filter by team access. Defaults to false so organization inboxes are not included (optional, default to false)_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 getEmailsCall(UUID inboxId, Integer limit, Long minCount, Long retryTimeout, OffsetDateTime since, Integer size, String sort, ApiCallback _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)limit - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)minCount - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)retryTimeout - Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)since - Exclude emails received before this ISO 8601 date time (optional)size - Alias for limit. Assessed first before assessing any passed limit. (optional)sort - Sort the results by received date and direction ASC or DESC (optional)_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 List<EmailPreview> getEmails(UUID inboxId, Integer limit, Long minCount, Long retryTimeout, OffsetDateTime since, Integer size, String sort) throws ApiException
inboxId - Id of inbox that emails belongs to (required)limit - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)minCount - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)retryTimeout - Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)since - Exclude emails received before this ISO 8601 date time (optional)size - Alias for limit. Assessed first before assessing any passed limit. (optional)sort - Sort the results by received date and direction ASC or DESC (optional)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<List<EmailPreview>> getEmailsWithHttpInfo(UUID inboxId, Integer limit, Long minCount, Long retryTimeout, OffsetDateTime since, Integer size, String sort) throws ApiException
inboxId - Id of inbox that emails belongs to (required)limit - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)minCount - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)retryTimeout - Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)since - Exclude emails received before this ISO 8601 date time (optional)size - Alias for limit. Assessed first before assessing any passed limit. (optional)sort - Sort the results by received date and direction ASC or DESC (optional)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 getEmailsAsync(UUID inboxId, Integer limit, Long minCount, Long retryTimeout, OffsetDateTime since, Integer size, String sort, ApiCallback<List<EmailPreview>> _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)limit - Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)minCount - Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)retryTimeout - Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)since - Exclude emails received before this ISO 8601 date time (optional)size - Alias for limit. Assessed first before assessing any passed limit. (optional)sort - Sort the results by received date and direction ASC or DESC (optional)_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 getInboxCall(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId - 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 Inbox getInbox(UUID inboxId) throws ApiException
inboxId - 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<Inbox> getInboxWithHttpInfo(UUID inboxId) throws ApiException
inboxId - 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 getInboxAsync(UUID inboxId, ApiCallback<Inbox> _callback) throws ApiException
inboxId - 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 getInboxEmailsPaginatedCall(UUID inboxId, Integer page, Integer size, String sort, ApiCallback _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)page - Optional page index in inbox emails list pagination (optional, default to 0)size - Optional page size in inbox emails 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 PageEmailPreview getInboxEmailsPaginated(UUID inboxId, Integer page, Integer size, String sort) throws ApiException
inboxId - Id of inbox that emails belongs to (required)page - Optional page index in inbox emails list pagination (optional, default to 0)size - Optional page size in inbox emails 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<PageEmailPreview> getInboxEmailsPaginatedWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort) throws ApiException
inboxId - Id of inbox that emails belongs to (required)page - Optional page index in inbox emails list pagination (optional, default to 0)size - Optional page size in inbox emails 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 getInboxEmailsPaginatedAsync(UUID inboxId, Integer page, Integer size, String sort, ApiCallback<PageEmailPreview> _callback) throws ApiException
inboxId - Id of inbox that emails belongs to (required)page - Optional page index in inbox emails list pagination (optional, default to 0)size - Optional page size in inbox emails 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 | - |
public okhttp3.Call getInboxSentEmailsCall(UUID inboxId, Integer page, Integer size, String sort, ApiCallback _callback) throws ApiException
inboxId - inboxId (required)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 PageSentEmailProjection getInboxSentEmails(UUID inboxId, Integer page, Integer size, String sort) throws ApiException
inboxId - inboxId (required)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<PageSentEmailProjection> getInboxSentEmailsWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort) throws ApiException
inboxId - inboxId (required)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 getInboxSentEmailsAsync(UUID inboxId, Integer page, Integer size, String sort, ApiCallback<PageSentEmailProjection> _callback) throws ApiException
inboxId - inboxId (required)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 | - |
public okhttp3.Call getInboxTagsCall(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 List<String> getInboxTags() 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<List<String>> getInboxTagsWithHttpInfo() 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 getInboxTagsAsync(ApiCallback<List<String>> _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 getInboxesCall(Integer size, String sort, ApiCallback _callback) throws ApiException
size - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)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 List<Inbox> getInboxes(Integer size, String sort) throws ApiException
size - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)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<List<Inbox>> getInboxesWithHttpInfo(Integer size, String sort) throws ApiException
size - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)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 getInboxesAsync(Integer size, String sort, ApiCallback<List<Inbox>> _callback) throws ApiException
size - Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (optional, default to 100)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 | - |
public okhttp3.Call getOrganizationInboxesCall(Integer page, Integer size, String sort, ApiCallback _callback) throws ApiException
page - Optional page index in inbox list pagination (optional, default to 0)size - Optional page size in inbox 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 PageOrganizationInboxProjection getOrganizationInboxes(Integer page, Integer size, String sort) throws ApiException
page - Optional page index in inbox list pagination (optional, default to 0)size - Optional page size in inbox 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<PageOrganizationInboxProjection> getOrganizationInboxesWithHttpInfo(Integer page, Integer size, String sort) throws ApiException
page - Optional page index in inbox list pagination (optional, default to 0)size - Optional page size in inbox 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 getOrganizationInboxesAsync(Integer page, Integer size, String sort, ApiCallback<PageOrganizationInboxProjection> _callback) throws ApiException
page - Optional page index in inbox list pagination (optional, default to 0)size - Optional page size in inbox 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 | - |
public okhttp3.Call sendEmailCall(UUID inboxId, SendEmailOptions sendEmailOptions, ApiCallback _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - Options for the email (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public void sendEmail(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - Options for the email (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<Void> sendEmailWithHttpInfo(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - Options for the email (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call sendEmailAsync(UUID inboxId, SendEmailOptions sendEmailOptions, ApiCallback<Void> _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - Options for the email (optional)_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 |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call sendEmailAndConfirmCall(UUID inboxId, SendEmailOptions sendEmailOptions, ApiCallback _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - Options for the email (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public SentEmailDto sendEmailAndConfirm(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - Options for the email (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<SentEmailDto> sendEmailAndConfirmWithHttpInfo(UUID inboxId, SendEmailOptions sendEmailOptions) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - Options for the email (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call sendEmailAndConfirmAsync(UUID inboxId, SendEmailOptions sendEmailOptions, ApiCallback<SentEmailDto> _callback) throws ApiException
inboxId - ID of the inbox you want to send the email from (required)sendEmailOptions - Options for the email (optional)_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 |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call setInboxFavouritedCall(UUID inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions, ApiCallback _callback) throws ApiException
inboxId - inboxId (required)setInboxFavouritedOptions - setInboxFavouritedOptions (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public Inbox setInboxFavourited(UUID inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions) throws ApiException
inboxId - inboxId (required)setInboxFavouritedOptions - setInboxFavouritedOptions (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 | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<Inbox> setInboxFavouritedWithHttpInfo(UUID inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions) throws ApiException
inboxId - inboxId (required)setInboxFavouritedOptions - setInboxFavouritedOptions (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 | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call setInboxFavouritedAsync(UUID inboxId, SetInboxFavouritedOptions setInboxFavouritedOptions, ApiCallback<Inbox> _callback) throws ApiException
inboxId - inboxId (required)setInboxFavouritedOptions - setInboxFavouritedOptions (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 | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call updateInboxCall(UUID inboxId, UpdateInboxOptions updateInboxOptions, ApiCallback _callback) throws ApiException
inboxId - inboxId (required)updateInboxOptions - updateInboxOptions (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public Inbox updateInbox(UUID inboxId, UpdateInboxOptions updateInboxOptions) throws ApiException
inboxId - inboxId (required)updateInboxOptions - updateInboxOptions (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 | - |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public ApiResponse<Inbox> updateInboxWithHttpInfo(UUID inboxId, UpdateInboxOptions updateInboxOptions) throws ApiException
inboxId - inboxId (required)updateInboxOptions - updateInboxOptions (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 | - |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call updateInboxAsync(UUID inboxId, UpdateInboxOptions updateInboxOptions, ApiCallback<Inbox> _callback) throws ApiException
inboxId - inboxId (required)updateInboxOptions - updateInboxOptions (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 | - |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
Copyright © 2021. All rights reserved.