Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* MailSlurp API
* MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
*
* The version of the OpenAPI document: 6.5.2
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.mailslurp.apis;
import com.mailslurp.clients.ApiCallback;
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.ApiResponse;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.Pair;
import com.mailslurp.clients.ProgressRequestBody;
import com.mailslurp.clients.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import com.mailslurp.models.CountDto;
import com.mailslurp.models.CreateInboxDto;
import com.mailslurp.models.CreateInboxRulesetOptions;
import com.mailslurp.models.Email;
import com.mailslurp.models.EmailAvailableResult;
import com.mailslurp.models.EmailPreview;
import com.mailslurp.models.FlushExpiredInboxesResult;
import com.mailslurp.models.ImapAccessDetails;
import com.mailslurp.models.ImapSmtpAccessDetails;
import com.mailslurp.models.ImapSmtpAccessServers;
import com.mailslurp.models.InboxByEmailAddressResult;
import com.mailslurp.models.InboxByNameResult;
import com.mailslurp.models.InboxDto;
import com.mailslurp.models.InboxExistsDto;
import com.mailslurp.models.InboxIdsResult;
import com.mailslurp.models.InboxRulesetDto;
import java.time.OffsetDateTime;
import com.mailslurp.models.PageDeliveryStatus;
import com.mailslurp.models.PageEmailPreview;
import com.mailslurp.models.PageInboxProjection;
import com.mailslurp.models.PageInboxRulesetDto;
import com.mailslurp.models.PageOrganizationInboxProjection;
import com.mailslurp.models.PageScheduledJobs;
import com.mailslurp.models.PageSentEmailProjection;
import com.mailslurp.models.PageTrackingPixelProjection;
import com.mailslurp.models.ScheduledJobDto;
import com.mailslurp.models.SearchInboxesOptions;
import com.mailslurp.models.SendEmailOptions;
import com.mailslurp.models.SendSMTPEnvelopeOptions;
import com.mailslurp.models.SentEmailDto;
import com.mailslurp.models.SetInboxFavouritedOptions;
import com.mailslurp.models.SmtpAccessDetails;
import java.util.UUID;
import com.mailslurp.models.UpdateImapAccessOptions;
import com.mailslurp.models.UpdateInboxOptions;
import com.mailslurp.models.UpdateSmtpAccessOptions;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class InboxControllerApi {
private ApiClient localVarApiClient;
public InboxControllerApi() {
this(Configuration.getDefaultApiClient());
}
public InboxControllerApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
/**
* Build call for cancelScheduledJob
* @param jobId (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
*/
public okhttp3.Call cancelScheduledJobCall(UUID jobId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/scheduled-jobs/{jobId}"
.replaceAll("\\{" + "jobId" + "\\}", localVarApiClient.escapeString(jobId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call cancelScheduledJobValidateBeforeCall(UUID jobId, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'jobId' is set
if (jobId == null) {
throw new ApiException("Missing the required parameter 'jobId' when calling cancelScheduledJob(Async)");
}
okhttp3.Call localVarCall = cancelScheduledJobCall(jobId, _callback);
return localVarCall;
}
/**
* Cancel a scheduled email job
* Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
* @param jobId (required)
* @return ScheduledJobDto
* @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
-
*/
public ScheduledJobDto cancelScheduledJob(UUID jobId) throws ApiException {
ApiResponse localVarResp = cancelScheduledJobWithHttpInfo(jobId);
return localVarResp.getData();
}
/**
* Cancel a scheduled email job
* Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
* @param jobId (required)
* @return ApiResponse<ScheduledJobDto>
* @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
-
*/
public ApiResponse cancelScheduledJobWithHttpInfo(UUID jobId) throws ApiException {
okhttp3.Call localVarCall = cancelScheduledJobValidateBeforeCall(jobId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Cancel a scheduled email job (asynchronously)
* Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
* @param jobId (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
-
*/
public okhttp3.Call cancelScheduledJobAsync(UUID jobId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = cancelScheduledJobValidateBeforeCall(jobId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for createInbox
* @param 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 `[email protected]`. 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 `[email protected]` or `[email protected]`. 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. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. 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)
* @param 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)
* @param name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)
* @param description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)
* @param 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. Note this feature is only available for `HTTP` inbox types. (optional)
* @param favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)
* @param 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)
* @param expiresIn Number of milliseconds that inbox should exist for (optional)
* @param allowTeamAccess DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)
* @param inboxType HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional)
* @param virtualInbox Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)
* @param useShortAddress Use a shorter email address under 31 characters (optional)
* @param domainId ID of custom domain to use for email address. (optional)
* @param domainName FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)
* @param prefix Prefix to add before the email address for easier labelling or identification. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
201
Created
-
*/
public okhttp3.Call createInboxCall(String emailAddress, List tags, String name, String description, Boolean useDomainPool, Boolean favourite, OffsetDateTime expiresAt, Long expiresIn, Boolean allowTeamAccess, String inboxType, Boolean virtualInbox, Boolean useShortAddress, UUID domainId, String domainName, String prefix, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (emailAddress != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("emailAddress", emailAddress));
}
if (tags != null) {
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "tags", tags));
}
if (name != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("name", name));
}
if (description != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("description", description));
}
if (useDomainPool != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("useDomainPool", useDomainPool));
}
if (favourite != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("favourite", favourite));
}
if (expiresAt != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("expiresAt", expiresAt));
}
if (expiresIn != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("expiresIn", expiresIn));
}
if (allowTeamAccess != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("allowTeamAccess", allowTeamAccess));
}
if (inboxType != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxType", inboxType));
}
if (virtualInbox != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("virtualInbox", virtualInbox));
}
if (useShortAddress != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("useShortAddress", useShortAddress));
}
if (domainId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("domainId", domainId));
}
if (domainName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("domainName", domainName));
}
if (prefix != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("prefix", prefix));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createInboxValidateBeforeCall(String emailAddress, List tags, String name, String description, Boolean useDomainPool, Boolean favourite, OffsetDateTime expiresAt, Long expiresIn, Boolean allowTeamAccess, String inboxType, Boolean virtualInbox, Boolean useShortAddress, UUID domainId, String domainName, String prefix, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createInboxCall(emailAddress, tags, name, description, useDomainPool, favourite, expiresAt, expiresIn, allowTeamAccess, inboxType, virtualInbox, useShortAddress, domainId, domainName, prefix, _callback);
return localVarCall;
}
/**
* Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
* Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
* @param 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 `[email protected]`. 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 `[email protected]` or `[email protected]`. 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. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. 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)
* @param 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)
* @param name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)
* @param description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)
* @param 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. Note this feature is only available for `HTTP` inbox types. (optional)
* @param favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)
* @param 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)
* @param expiresIn Number of milliseconds that inbox should exist for (optional)
* @param allowTeamAccess DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)
* @param inboxType HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional)
* @param virtualInbox Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)
* @param useShortAddress Use a shorter email address under 31 characters (optional)
* @param domainId ID of custom domain to use for email address. (optional)
* @param domainName FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)
* @param prefix Prefix to add before the email address for easier labelling or identification. (optional)
* @return InboxDto
* @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
201
Created
-
*/
public InboxDto createInbox(String emailAddress, List tags, String name, String description, Boolean useDomainPool, Boolean favourite, OffsetDateTime expiresAt, Long expiresIn, Boolean allowTeamAccess, String inboxType, Boolean virtualInbox, Boolean useShortAddress, UUID domainId, String domainName, String prefix) throws ApiException {
ApiResponse localVarResp = createInboxWithHttpInfo(emailAddress, tags, name, description, useDomainPool, favourite, expiresAt, expiresIn, allowTeamAccess, inboxType, virtualInbox, useShortAddress, domainId, domainName, prefix);
return localVarResp.getData();
}
/**
* Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
* Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
* @param 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 `[email protected]`. 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 `[email protected]` or `[email protected]`. 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. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. 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)
* @param 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)
* @param name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)
* @param description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)
* @param 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. Note this feature is only available for `HTTP` inbox types. (optional)
* @param favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)
* @param 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)
* @param expiresIn Number of milliseconds that inbox should exist for (optional)
* @param allowTeamAccess DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)
* @param inboxType HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional)
* @param virtualInbox Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)
* @param useShortAddress Use a shorter email address under 31 characters (optional)
* @param domainId ID of custom domain to use for email address. (optional)
* @param domainName FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)
* @param prefix Prefix to add before the email address for easier labelling or identification. (optional)
* @return ApiResponse<InboxDto>
* @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
201
Created
-
*/
public ApiResponse createInboxWithHttpInfo(String emailAddress, List tags, String name, String description, Boolean useDomainPool, Boolean favourite, OffsetDateTime expiresAt, Long expiresIn, Boolean allowTeamAccess, String inboxType, Boolean virtualInbox, Boolean useShortAddress, UUID domainId, String domainName, String prefix) throws ApiException {
okhttp3.Call localVarCall = createInboxValidateBeforeCall(emailAddress, tags, name, description, useDomainPool, favourite, expiresAt, expiresIn, allowTeamAccess, inboxType, virtualInbox, useShortAddress, domainId, domainName, prefix, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. (asynchronously)
* Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
* @param 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 `[email protected]`. 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 `[email protected]` or `[email protected]`. 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. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. 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)
* @param 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)
* @param name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails. (optional)
* @param description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with (optional)
* @param 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. Note this feature is only available for `HTTP` inbox types. (optional)
* @param favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering (optional)
* @param 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)
* @param expiresIn Number of milliseconds that inbox should exist for (optional)
* @param allowTeamAccess DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization. (optional)
* @param inboxType HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mxslurp.click`. (optional)
* @param virtualInbox Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending. (optional)
* @param useShortAddress Use a shorter email address under 31 characters (optional)
* @param domainId ID of custom domain to use for email address. (optional)
* @param domainName FQDN domain name for the domain you have verified. Will be appended with a randomly assigned recipient name. Use the `emailAddress` option instead to specify the full custom inbox. (optional)
* @param prefix Prefix to add before the email address for easier labelling or identification. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return 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
201
Created
-
*/
public okhttp3.Call createInboxAsync(String emailAddress, List tags, String name, String description, Boolean useDomainPool, Boolean favourite, OffsetDateTime expiresAt, Long expiresIn, Boolean allowTeamAccess, String inboxType, Boolean virtualInbox, Boolean useShortAddress, UUID domainId, String domainName, String prefix, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createInboxValidateBeforeCall(emailAddress, tags, name, description, useDomainPool, favourite, expiresAt, expiresIn, allowTeamAccess, inboxType, virtualInbox, useShortAddress, domainId, domainName, prefix, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for createInboxRuleset
* @param inboxId inboxId (required)
* @param createInboxRulesetOptions (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
*/
public okhttp3.Call createInboxRulesetCall(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = createInboxRulesetOptions;
// create path and map variables
String localVarPath = "/inboxes/{inboxId}/rulesets"
.replaceAll("\\{" + "inboxId" + "\\}", localVarApiClient.escapeString(inboxId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createInboxRulesetValidateBeforeCall(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'inboxId' is set
if (inboxId == null) {
throw new ApiException("Missing the required parameter 'inboxId' when calling createInboxRuleset(Async)");
}
// verify the required parameter 'createInboxRulesetOptions' is set
if (createInboxRulesetOptions == null) {
throw new ApiException("Missing the required parameter 'createInboxRulesetOptions' when calling createInboxRuleset(Async)");
}
okhttp3.Call localVarCall = createInboxRulesetCall(inboxId, createInboxRulesetOptions, _callback);
return localVarCall;
}
/**
* Create an inbox ruleset
* Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
* @param inboxId inboxId (required)
* @param createInboxRulesetOptions (required)
* @return InboxRulesetDto
* @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
-
*/
public InboxRulesetDto createInboxRuleset(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions) throws ApiException {
ApiResponse localVarResp = createInboxRulesetWithHttpInfo(inboxId, createInboxRulesetOptions);
return localVarResp.getData();
}
/**
* Create an inbox ruleset
* Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
* @param inboxId inboxId (required)
* @param createInboxRulesetOptions (required)
* @return ApiResponse<InboxRulesetDto>
* @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
-
*/
public ApiResponse createInboxRulesetWithHttpInfo(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions) throws ApiException {
okhttp3.Call localVarCall = createInboxRulesetValidateBeforeCall(inboxId, createInboxRulesetOptions, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Create an inbox ruleset (asynchronously)
* Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
* @param inboxId inboxId (required)
* @param createInboxRulesetOptions (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
-
*/
public okhttp3.Call createInboxRulesetAsync(UUID inboxId, CreateInboxRulesetOptions createInboxRulesetOptions, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createInboxRulesetValidateBeforeCall(inboxId, createInboxRulesetOptions, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for createInboxWithDefaults
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
201
Created
-
*/
public okhttp3.Call createInboxWithDefaultsCall(final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/withDefaults";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createInboxWithDefaultsValidateBeforeCall(final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createInboxWithDefaultsCall(_callback);
return localVarCall;
}
/**
* Create an inbox with default options. Uses MailSlurp domain pool address and is private.
*
* @return InboxDto
* @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
201
Created
-
*/
public InboxDto createInboxWithDefaults() throws ApiException {
ApiResponse localVarResp = createInboxWithDefaultsWithHttpInfo();
return localVarResp.getData();
}
/**
* Create an inbox with default options. Uses MailSlurp domain pool address and is private.
*
* @return ApiResponse<InboxDto>
* @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
201
Created
-
*/
public ApiResponse createInboxWithDefaultsWithHttpInfo() throws ApiException {
okhttp3.Call localVarCall = createInboxWithDefaultsValidateBeforeCall(null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Create an inbox with default options. Uses MailSlurp domain pool address and is private. (asynchronously)
*
* @param _callback The callback to be executed when the API call finishes
* @return 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
201
Created
-
*/
public okhttp3.Call createInboxWithDefaultsAsync(final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createInboxWithDefaultsValidateBeforeCall(_callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for createInboxWithOptions
* @param createInboxDto (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
201
Created
-
*/
public okhttp3.Call createInboxWithOptionsCall(CreateInboxDto createInboxDto, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = createInboxDto;
// create path and map variables
String localVarPath = "/inboxes/withOptions";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createInboxWithOptionsValidateBeforeCall(CreateInboxDto createInboxDto, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'createInboxDto' is set
if (createInboxDto == null) {
throw new ApiException("Missing the required parameter 'createInboxDto' when calling createInboxWithOptions(Async)");
}
okhttp3.Call localVarCall = createInboxWithOptionsCall(createInboxDto, _callback);
return localVarCall;
}
/**
* Create an inbox with options. Extended options for inbox creation.
* Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
* @param createInboxDto (required)
* @return InboxDto
* @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
201
Created
-
*/
public InboxDto createInboxWithOptions(CreateInboxDto createInboxDto) throws ApiException {
ApiResponse localVarResp = createInboxWithOptionsWithHttpInfo(createInboxDto);
return localVarResp.getData();
}
/**
* Create an inbox with options. Extended options for inbox creation.
* Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
* @param createInboxDto (required)
* @return ApiResponse<InboxDto>
* @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
201
Created
-
*/
public ApiResponse createInboxWithOptionsWithHttpInfo(CreateInboxDto createInboxDto) throws ApiException {
okhttp3.Call localVarCall = createInboxWithOptionsValidateBeforeCall(createInboxDto, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Create an inbox with options. Extended options for inbox creation. (asynchronously)
* Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
* @param createInboxDto (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
201
Created
-
*/
public okhttp3.Call createInboxWithOptionsAsync(CreateInboxDto createInboxDto, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createInboxWithOptionsValidateBeforeCall(createInboxDto, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deleteAllInboxEmails
* @param inboxId (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
*/
public okhttp3.Call deleteAllInboxEmailsCall(UUID inboxId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/{inboxId}/deleteAllInboxEmails"
.replaceAll("\\{" + "inboxId" + "\\}", localVarApiClient.escapeString(inboxId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteAllInboxEmailsValidateBeforeCall(UUID inboxId, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'inboxId' is set
if (inboxId == null) {
throw new ApiException("Missing the required parameter 'inboxId' when calling deleteAllInboxEmails(Async)");
}
okhttp3.Call localVarCall = deleteAllInboxEmailsCall(inboxId, _callback);
return localVarCall;
}
/**
* Delete all emails in a given inboxes.
* Deletes all emails in an inbox. Be careful as emails cannot be recovered
* @param inboxId (required)
* @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
204
No Content
-
*/
public void deleteAllInboxEmails(UUID inboxId) throws ApiException {
deleteAllInboxEmailsWithHttpInfo(inboxId);
}
/**
* Delete all emails in a given inboxes.
* Deletes all emails in an inbox. Be careful as emails cannot be recovered
* @param inboxId (required)
* @return 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
204
No Content
-
*/
public ApiResponse deleteAllInboxEmailsWithHttpInfo(UUID inboxId) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxEmailsValidateBeforeCall(inboxId, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Delete all emails in a given inboxes. (asynchronously)
* Deletes all emails in an inbox. Be careful as emails cannot be recovered
* @param inboxId (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
204
No Content
-
*/
public okhttp3.Call deleteAllInboxEmailsAsync(UUID inboxId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxEmailsValidateBeforeCall(inboxId, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for deleteAllInboxes
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
*/
public okhttp3.Call deleteAllInboxesCall(final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteAllInboxesValidateBeforeCall(final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesCall(_callback);
return localVarCall;
}
/**
* Delete all inboxes
* Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
* @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
204
No Content
-
*/
public void deleteAllInboxes() throws ApiException {
deleteAllInboxesWithHttpInfo();
}
/**
* Delete all inboxes
* Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
* @return 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
204
No Content
-
*/
public ApiResponse deleteAllInboxesWithHttpInfo() throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesValidateBeforeCall(null);
return localVarApiClient.execute(localVarCall);
}
/**
* Delete all inboxes (asynchronously)
* Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
* @param _callback The callback to be executed when the API call finishes
* @return 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
204
No Content
-
*/
public okhttp3.Call deleteAllInboxesAsync(final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesValidateBeforeCall(_callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for deleteAllInboxesByDescription
* @param description (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
*/
public okhttp3.Call deleteAllInboxesByDescriptionCall(String description, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/by-description";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (description != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("description", description));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteAllInboxesByDescriptionValidateBeforeCall(String description, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'description' is set
if (description == null) {
throw new ApiException("Missing the required parameter 'description' when calling deleteAllInboxesByDescription(Async)");
}
okhttp3.Call localVarCall = deleteAllInboxesByDescriptionCall(description, _callback);
return localVarCall;
}
/**
* Delete inboxes by description
* Permanently delete all inboxes by description
* @param description (required)
* @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
204
No Content
-
*/
public void deleteAllInboxesByDescription(String description) throws ApiException {
deleteAllInboxesByDescriptionWithHttpInfo(description);
}
/**
* Delete inboxes by description
* Permanently delete all inboxes by description
* @param description (required)
* @return 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
204
No Content
-
*/
public ApiResponse deleteAllInboxesByDescriptionWithHttpInfo(String description) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesByDescriptionValidateBeforeCall(description, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Delete inboxes by description (asynchronously)
* Permanently delete all inboxes by description
* @param description (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
204
No Content
-
*/
public okhttp3.Call deleteAllInboxesByDescriptionAsync(String description, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesByDescriptionValidateBeforeCall(description, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for deleteAllInboxesByName
* @param name (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
*/
public okhttp3.Call deleteAllInboxesByNameCall(String name, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/by-name";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (name != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("name", name));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteAllInboxesByNameValidateBeforeCall(String name, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'name' is set
if (name == null) {
throw new ApiException("Missing the required parameter 'name' when calling deleteAllInboxesByName(Async)");
}
okhttp3.Call localVarCall = deleteAllInboxesByNameCall(name, _callback);
return localVarCall;
}
/**
* Delete inboxes by name
* Permanently delete all inboxes by name
* @param name (required)
* @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
204
No Content
-
*/
public void deleteAllInboxesByName(String name) throws ApiException {
deleteAllInboxesByNameWithHttpInfo(name);
}
/**
* Delete inboxes by name
* Permanently delete all inboxes by name
* @param name (required)
* @return 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
204
No Content
-
*/
public ApiResponse deleteAllInboxesByNameWithHttpInfo(String name) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesByNameValidateBeforeCall(name, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Delete inboxes by name (asynchronously)
* Permanently delete all inboxes by name
* @param name (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
204
No Content
-
*/
public okhttp3.Call deleteAllInboxesByNameAsync(String name, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesByNameValidateBeforeCall(name, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for deleteAllInboxesByTag
* @param tag (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
*/
public okhttp3.Call deleteAllInboxesByTagCall(String tag, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/by-tag";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (tag != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteAllInboxesByTagValidateBeforeCall(String tag, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'tag' is set
if (tag == null) {
throw new ApiException("Missing the required parameter 'tag' when calling deleteAllInboxesByTag(Async)");
}
okhttp3.Call localVarCall = deleteAllInboxesByTagCall(tag, _callback);
return localVarCall;
}
/**
* Delete inboxes by tag
* Permanently delete all inboxes by tag
* @param tag (required)
* @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
204
No Content
-
*/
public void deleteAllInboxesByTag(String tag) throws ApiException {
deleteAllInboxesByTagWithHttpInfo(tag);
}
/**
* Delete inboxes by tag
* Permanently delete all inboxes by tag
* @param tag (required)
* @return 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
204
No Content
-
*/
public ApiResponse deleteAllInboxesByTagWithHttpInfo(String tag) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesByTagValidateBeforeCall(tag, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Delete inboxes by tag (asynchronously)
* Permanently delete all inboxes by tag
* @param tag (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
204
No Content
-
*/
public okhttp3.Call deleteAllInboxesByTagAsync(String tag, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteAllInboxesByTagValidateBeforeCall(tag, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for deleteInbox
* @param inboxId (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
*/
public okhttp3.Call deleteInboxCall(UUID inboxId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/{inboxId}"
.replaceAll("\\{" + "inboxId" + "\\}", localVarApiClient.escapeString(inboxId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteInboxValidateBeforeCall(UUID inboxId, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'inboxId' is set
if (inboxId == null) {
throw new ApiException("Missing the required parameter 'inboxId' when calling deleteInbox(Async)");
}
okhttp3.Call localVarCall = deleteInboxCall(inboxId, _callback);
return localVarCall;
}
/**
* Delete inbox
* Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
* @param inboxId (required)
* @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
204
No Content
-
*/
public void deleteInbox(UUID inboxId) throws ApiException {
deleteInboxWithHttpInfo(inboxId);
}
/**
* Delete inbox
* Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
* @param inboxId (required)
* @return 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
204
No Content
-
*/
public ApiResponse deleteInboxWithHttpInfo(UUID inboxId) throws ApiException {
okhttp3.Call localVarCall = deleteInboxValidateBeforeCall(inboxId, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Delete inbox (asynchronously)
* Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
* @param inboxId (required)
* @param _callback The callback to be executed when the API call finishes
* @return 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
204
No Content
-
*/
public okhttp3.Call deleteInboxAsync(UUID inboxId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteInboxValidateBeforeCall(inboxId, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for doesInboxExist
* @param emailAddress Email address (required)
* @param allowCatchAll (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
*/
public okhttp3.Call doesInboxExistCall(String emailAddress, Boolean allowCatchAll, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/exists";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (emailAddress != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("emailAddress", emailAddress));
}
if (allowCatchAll != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("allowCatchAll", allowCatchAll));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call doesInboxExistValidateBeforeCall(String emailAddress, Boolean allowCatchAll, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'emailAddress' is set
if (emailAddress == null) {
throw new ApiException("Missing the required parameter 'emailAddress' when calling doesInboxExist(Async)");
}
okhttp3.Call localVarCall = doesInboxExistCall(emailAddress, allowCatchAll, _callback);
return localVarCall;
}
/**
* Does inbox exist
* Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses
* @param emailAddress Email address (required)
* @param allowCatchAll (optional)
* @return InboxExistsDto
* @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
-
*/
public InboxExistsDto doesInboxExist(String emailAddress, Boolean allowCatchAll) throws ApiException {
ApiResponse localVarResp = doesInboxExistWithHttpInfo(emailAddress, allowCatchAll);
return localVarResp.getData();
}
/**
* Does inbox exist
* Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses
* @param emailAddress Email address (required)
* @param allowCatchAll (optional)
* @return ApiResponse<InboxExistsDto>
* @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
-
*/
public ApiResponse doesInboxExistWithHttpInfo(String emailAddress, Boolean allowCatchAll) throws ApiException {
okhttp3.Call localVarCall = doesInboxExistValidateBeforeCall(emailAddress, allowCatchAll, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Does inbox exist (asynchronously)
* Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses
* @param emailAddress Email address (required)
* @param allowCatchAll (optional)
* @param _callback The callback to be executed when the API call finishes
* @return 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
-
*/
public okhttp3.Call doesInboxExistAsync(String emailAddress, Boolean allowCatchAll, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = doesInboxExistValidateBeforeCall(emailAddress, allowCatchAll, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for flushExpired
* @param before Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
*/
public okhttp3.Call flushExpiredCall(OffsetDateTime before, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/expired";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (before != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call flushExpiredValidateBeforeCall(OffsetDateTime before, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = flushExpiredCall(before, _callback);
return localVarCall;
}
/**
* Remove expired inboxes
* Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
* @param before Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)
* @return FlushExpiredInboxesResult
* @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
-
*/
public FlushExpiredInboxesResult flushExpired(OffsetDateTime before) throws ApiException {
ApiResponse localVarResp = flushExpiredWithHttpInfo(before);
return localVarResp.getData();
}
/**
* Remove expired inboxes
* Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
* @param before Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)
* @return ApiResponse<FlushExpiredInboxesResult>
* @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
-
*/
public ApiResponse flushExpiredWithHttpInfo(OffsetDateTime before) throws ApiException {
okhttp3.Call localVarCall = flushExpiredValidateBeforeCall(before, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Remove expired inboxes (asynchronously)
* Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
* @param before Optional expired at before flag to flush expired inboxes that have expired before the given time (optional)
* @param _callback The callback to be executed when the API call finishes
* @return 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
-
*/
public okhttp3.Call flushExpiredAsync(OffsetDateTime before, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = flushExpiredValidateBeforeCall(before, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getAllInboxes
* @param page Optional page index in list pagination (optional, default to 0)
* @param size Optional page size in list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param favourite Optionally filter results for favourites only (optional, default to false)
* @param search Optionally filter by search words partial matching ID, tags, name, and email address (optional)
* @param tag Optionally filter by tags. Will return inboxes that include given tags (optional)
* @param teamAccess DEPRECATED. Optionally filter by team access. (optional)
* @param since Optional filter by created after given date time (optional)
* @param before Optional filter by created before given date time (optional)
* @param inboxType Optional filter by inbox type (optional)
* @param inboxFunction Optional filter by inbox function (optional)
* @param domainId Optional domain ID filter (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
*/
public okhttp3.Call getAllInboxesCall(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/paginated";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (size != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size));
}
if (sort != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort));
}
if (favourite != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("favourite", favourite));
}
if (search != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("search", search));
}
if (tag != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag));
}
if (teamAccess != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("teamAccess", teamAccess));
}
if (since != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("since", since));
}
if (before != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before));
}
if (inboxType != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxType", inboxType));
}
if (inboxFunction != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxFunction", inboxFunction));
}
if (domainId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("domainId", domainId));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getAllInboxesValidateBeforeCall(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAllInboxesCall(page, size, sort, favourite, search, tag, teamAccess, since, before, inboxType, inboxFunction, domainId, _callback);
return localVarCall;
}
/**
* List All Inboxes Paginated
* List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
* @param page Optional page index in list pagination (optional, default to 0)
* @param size Optional page size in list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param favourite Optionally filter results for favourites only (optional, default to false)
* @param search Optionally filter by search words partial matching ID, tags, name, and email address (optional)
* @param tag Optionally filter by tags. Will return inboxes that include given tags (optional)
* @param teamAccess DEPRECATED. Optionally filter by team access. (optional)
* @param since Optional filter by created after given date time (optional)
* @param before Optional filter by created before given date time (optional)
* @param inboxType Optional filter by inbox type (optional)
* @param inboxFunction Optional filter by inbox function (optional)
* @param domainId Optional domain ID filter (optional)
* @return PageInboxProjection
* @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
-
*/
public PageInboxProjection getAllInboxes(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId) throws ApiException {
ApiResponse localVarResp = getAllInboxesWithHttpInfo(page, size, sort, favourite, search, tag, teamAccess, since, before, inboxType, inboxFunction, domainId);
return localVarResp.getData();
}
/**
* List All Inboxes Paginated
* List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
* @param page Optional page index in list pagination (optional, default to 0)
* @param size Optional page size in list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param favourite Optionally filter results for favourites only (optional, default to false)
* @param search Optionally filter by search words partial matching ID, tags, name, and email address (optional)
* @param tag Optionally filter by tags. Will return inboxes that include given tags (optional)
* @param teamAccess DEPRECATED. Optionally filter by team access. (optional)
* @param since Optional filter by created after given date time (optional)
* @param before Optional filter by created before given date time (optional)
* @param inboxType Optional filter by inbox type (optional)
* @param inboxFunction Optional filter by inbox function (optional)
* @param domainId Optional domain ID filter (optional)
* @return ApiResponse<PageInboxProjection>
* @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
-
*/
public ApiResponse getAllInboxesWithHttpInfo(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId) throws ApiException {
okhttp3.Call localVarCall = getAllInboxesValidateBeforeCall(page, size, sort, favourite, search, tag, teamAccess, since, before, inboxType, inboxFunction, domainId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* List All Inboxes Paginated (asynchronously)
* List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
* @param page Optional page index in list pagination (optional, default to 0)
* @param size Optional page size in list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param favourite Optionally filter results for favourites only (optional, default to false)
* @param search Optionally filter by search words partial matching ID, tags, name, and email address (optional)
* @param tag Optionally filter by tags. Will return inboxes that include given tags (optional)
* @param teamAccess DEPRECATED. Optionally filter by team access. (optional)
* @param since Optional filter by created after given date time (optional)
* @param before Optional filter by created before given date time (optional)
* @param inboxType Optional filter by inbox type (optional)
* @param inboxFunction Optional filter by inbox function (optional)
* @param domainId Optional domain ID filter (optional)
* @param _callback The callback to be executed when the API call finishes
* @return 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
-
*/
public okhttp3.Call getAllInboxesAsync(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAllInboxesValidateBeforeCall(page, size, sort, favourite, search, tag, teamAccess, since, before, inboxType, inboxFunction, domainId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getAllInboxesOffsetPaginated
* @param page Optional page index in list pagination (optional, default to 0)
* @param size Optional page size in list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param favourite Optionally filter results for favourites only (optional, default to false)
* @param search Optionally filter by search words partial matching ID, tags, name, and email address (optional)
* @param tag Optionally filter by tags. Will return inboxes that include given tags (optional)
* @param teamAccess DEPRECATED. Optionally filter by team access. (optional)
* @param since Optional filter by created after given date time (optional)
* @param before Optional filter by created before given date time (optional)
* @param inboxType Optional filter by inbox type (optional)
* @param inboxFunction Optional filter by inbox function (optional)
* @param domainId Optional domain ID filter (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
*/
public okhttp3.Call getAllInboxesOffsetPaginatedCall(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/offset-paginated";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (size != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size));
}
if (sort != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort));
}
if (favourite != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("favourite", favourite));
}
if (search != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("search", search));
}
if (tag != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("tag", tag));
}
if (teamAccess != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("teamAccess", teamAccess));
}
if (since != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("since", since));
}
if (before != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before));
}
if (inboxType != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxType", inboxType));
}
if (inboxFunction != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("inboxFunction", inboxFunction));
}
if (domainId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("domainId", domainId));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getAllInboxesOffsetPaginatedValidateBeforeCall(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAllInboxesOffsetPaginatedCall(page, size, sort, favourite, search, tag, teamAccess, since, before, inboxType, inboxFunction, domainId, _callback);
return localVarCall;
}
/**
* List All Inboxes Offset Paginated
* List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
* @param page Optional page index in list pagination (optional, default to 0)
* @param size Optional page size in list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param favourite Optionally filter results for favourites only (optional, default to false)
* @param search Optionally filter by search words partial matching ID, tags, name, and email address (optional)
* @param tag Optionally filter by tags. Will return inboxes that include given tags (optional)
* @param teamAccess DEPRECATED. Optionally filter by team access. (optional)
* @param since Optional filter by created after given date time (optional)
* @param before Optional filter by created before given date time (optional)
* @param inboxType Optional filter by inbox type (optional)
* @param inboxFunction Optional filter by inbox function (optional)
* @param domainId Optional domain ID filter (optional)
* @return PageInboxProjection
* @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
-
*/
public PageInboxProjection getAllInboxesOffsetPaginated(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId) throws ApiException {
ApiResponse localVarResp = getAllInboxesOffsetPaginatedWithHttpInfo(page, size, sort, favourite, search, tag, teamAccess, since, before, inboxType, inboxFunction, domainId);
return localVarResp.getData();
}
/**
* List All Inboxes Offset Paginated
* List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
* @param page Optional page index in list pagination (optional, default to 0)
* @param size Optional page size in list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param favourite Optionally filter results for favourites only (optional, default to false)
* @param search Optionally filter by search words partial matching ID, tags, name, and email address (optional)
* @param tag Optionally filter by tags. Will return inboxes that include given tags (optional)
* @param teamAccess DEPRECATED. Optionally filter by team access. (optional)
* @param since Optional filter by created after given date time (optional)
* @param before Optional filter by created before given date time (optional)
* @param inboxType Optional filter by inbox type (optional)
* @param inboxFunction Optional filter by inbox function (optional)
* @param domainId Optional domain ID filter (optional)
* @return ApiResponse<PageInboxProjection>
* @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
-
*/
public ApiResponse getAllInboxesOffsetPaginatedWithHttpInfo(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId) throws ApiException {
okhttp3.Call localVarCall = getAllInboxesOffsetPaginatedValidateBeforeCall(page, size, sort, favourite, search, tag, teamAccess, since, before, inboxType, inboxFunction, domainId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* List All Inboxes Offset Paginated (asynchronously)
* List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
* @param page Optional page index in list pagination (optional, default to 0)
* @param size Optional page size in list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param favourite Optionally filter results for favourites only (optional, default to false)
* @param search Optionally filter by search words partial matching ID, tags, name, and email address (optional)
* @param tag Optionally filter by tags. Will return inboxes that include given tags (optional)
* @param teamAccess DEPRECATED. Optionally filter by team access. (optional)
* @param since Optional filter by created after given date time (optional)
* @param before Optional filter by created before given date time (optional)
* @param inboxType Optional filter by inbox type (optional)
* @param inboxFunction Optional filter by inbox function (optional)
* @param domainId Optional domain ID filter (optional)
* @param _callback The callback to be executed when the API call finishes
* @return 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
-
*/
public okhttp3.Call getAllInboxesOffsetPaginatedAsync(Integer page, Integer size, String sort, Boolean favourite, String search, String tag, Boolean teamAccess, OffsetDateTime since, OffsetDateTime before, String inboxType, String inboxFunction, UUID domainId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAllInboxesOffsetPaginatedValidateBeforeCall(page, size, sort, favourite, search, tag, teamAccess, since, before, inboxType, inboxFunction, domainId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getAllScheduledJobs
* @param page Optional page index in scheduled job list pagination (optional, default to 0)
* @param size Optional page size in scheduled job list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param since Filter by created at after the given timestamp (optional)
* @param before Filter by created at before the given timestamp (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
*/
public okhttp3.Call getAllScheduledJobsCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/scheduled-jobs";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (size != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size));
}
if (sort != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort));
}
if (since != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("since", since));
}
if (before != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getAllScheduledJobsValidateBeforeCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAllScheduledJobsCall(page, size, sort, since, before, _callback);
return localVarCall;
}
/**
* Get all scheduled email sending jobs for account
* Schedule sending of emails using scheduled jobs. These can be inbox or account level.
* @param page Optional page index in scheduled job list pagination (optional, default to 0)
* @param size Optional page size in scheduled job list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param since Filter by created at after the given timestamp (optional)
* @param before Filter by created at before the given timestamp (optional)
* @return PageScheduledJobs
* @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
-
*/
public PageScheduledJobs getAllScheduledJobs(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException {
ApiResponse localVarResp = getAllScheduledJobsWithHttpInfo(page, size, sort, since, before);
return localVarResp.getData();
}
/**
* Get all scheduled email sending jobs for account
* Schedule sending of emails using scheduled jobs. These can be inbox or account level.
* @param page Optional page index in scheduled job list pagination (optional, default to 0)
* @param size Optional page size in scheduled job list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param since Filter by created at after the given timestamp (optional)
* @param before Filter by created at before the given timestamp (optional)
* @return ApiResponse<PageScheduledJobs>
* @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
-
*/
public ApiResponse getAllScheduledJobsWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException {
okhttp3.Call localVarCall = getAllScheduledJobsValidateBeforeCall(page, size, sort, since, before, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get all scheduled email sending jobs for account (asynchronously)
* Schedule sending of emails using scheduled jobs. These can be inbox or account level.
* @param page Optional page index in scheduled job list pagination (optional, default to 0)
* @param size Optional page size in scheduled job list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param since Filter by created at after the given timestamp (optional)
* @param before Filter by created at before the given timestamp (optional)
* @param _callback The callback to be executed when the API call finishes
* @return 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
-
*/
public okhttp3.Call getAllScheduledJobsAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAllScheduledJobsValidateBeforeCall(page, size, sort, since, before, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getDeliveryStatusesByInboxId
* @param inboxId (required)
* @param page Optional page index in delivery status list pagination (optional, default to 0)
* @param size Optional page size in delivery status list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param since Filter by created at after the given timestamp (optional)
* @param before Filter by created at before the given timestamp (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
* @deprecated
*/
@Deprecated
public okhttp3.Call getDeliveryStatusesByInboxIdCall(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/{inboxId}/delivery-status"
.replaceAll("\\{" + "inboxId" + "\\}", localVarApiClient.escapeString(inboxId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (size != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size));
}
if (sort != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort));
}
if (since != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("since", since));
}
if (before != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"*/*"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "API_KEY" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@Deprecated
@SuppressWarnings("rawtypes")
private okhttp3.Call getDeliveryStatusesByInboxIdValidateBeforeCall(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'inboxId' is set
if (inboxId == null) {
throw new ApiException("Missing the required parameter 'inboxId' when calling getDeliveryStatusesByInboxId(Async)");
}
okhttp3.Call localVarCall = getDeliveryStatusesByInboxIdCall(inboxId, page, size, sort, since, before, _callback);
return localVarCall;
}
/**
*
* Get all email delivery statuses for an inbox
* @param inboxId (required)
* @param page Optional page index in delivery status list pagination (optional, default to 0)
* @param size Optional page size in delivery status list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param since Filter by created at after the given timestamp (optional)
* @param before Filter by created at before the given timestamp (optional)
* @return PageDeliveryStatus
* @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
-
* @deprecated
*/
@Deprecated
public PageDeliveryStatus getDeliveryStatusesByInboxId(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException {
ApiResponse localVarResp = getDeliveryStatusesByInboxIdWithHttpInfo(inboxId, page, size, sort, since, before);
return localVarResp.getData();
}
/**
*
* Get all email delivery statuses for an inbox
* @param inboxId (required)
* @param page Optional page index in delivery status list pagination (optional, default to 0)
* @param size Optional page size in delivery status list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param since Filter by created at after the given timestamp (optional)
* @param before Filter by created at before the given timestamp (optional)
* @return ApiResponse<PageDeliveryStatus>
* @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
-
* @deprecated
*/
@Deprecated
public ApiResponse getDeliveryStatusesByInboxIdWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) throws ApiException {
okhttp3.Call localVarCall = getDeliveryStatusesByInboxIdValidateBeforeCall(inboxId, page, size, sort, since, before, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get all email delivery statuses for an inbox
* @param inboxId (required)
* @param page Optional page index in delivery status list pagination (optional, default to 0)
* @param size Optional page size in delivery status list pagination (optional, default to 20)
* @param sort Optional createdAt sort direction ASC or DESC (optional, default to ASC)
* @param since Filter by created at after the given timestamp (optional)
* @param before Filter by created at before the given timestamp (optional)
* @param _callback The callback to be executed when the API call finishes
* @return 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
-
* @deprecated
*/
@Deprecated
public okhttp3.Call getDeliveryStatusesByInboxIdAsync(UUID inboxId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getDeliveryStatusesByInboxIdValidateBeforeCall(inboxId, page, size, sort, since, before, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getEmails
* @param inboxId Id of inbox that emails belongs to (required)
* @param size Alias for limit. Assessed first before assessing any passed limit. (optional)
* @param limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller (optional)
* @param sort Sort the results by received date and direction ASC or DESC (optional)
* @param retryTimeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned (optional)
* @param delayTimeout (optional)
* @param minCount Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. (optional)
* @param unreadOnly (optional)
* @param before Exclude emails received after this ISO 8601 date time (optional)
* @param since Exclude emails received before this ISO 8601 date time (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
*/
public okhttp3.Call getEmailsCall(UUID inboxId, Integer size, Integer limit, String sort, Long retryTimeout, Long delayTimeout, Long minCount, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/inboxes/{inboxId}/emails"
.replaceAll("\\{" + "inboxId" + "\\}", localVarApiClient.escapeString(inboxId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (size != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("size", size));
}
if (limit != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit));
}
if (sort != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sort", sort));
}
if (retryTimeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("retryTimeout", retryTimeout));
}
if (delayTimeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("delayTimeout", delayTimeout));
}
if (minCount != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("minCount", minCount));
}
if (unreadOnly != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("unreadOnly", unreadOnly));
}
if (before != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before));
}
if (since != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("since", since));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map
