com.mailslurp.apis

Class WaitForControllerApi

java.lang.Object

com.mailslurp.apis.WaitForControllerApi

public class WaitForControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WaitForControllerApi()
WaitForControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
List<EmailPreview>	waitFor(WaitForConditions waitForConditions) Wait for an email to match the provided filter conditions such as subject contains keyword.
okhttp3.Call	waitForAsync(WaitForConditions waitForConditions, ApiCallback<List<EmailPreview>> _callback) Wait for an email to match the provided filter conditions such as subject contains keyword.
okhttp3.Call	waitForCall(WaitForConditions waitForConditions, ApiCallback _callback) Build call for waitFor
List<EmailPreview>	waitForEmailCount(UUID inboxId, Integer count, Long timeout, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, String sort, Long delay) Wait for and return count number of emails.
okhttp3.Call	waitForEmailCountAsync(UUID inboxId, Integer count, Long timeout, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, String sort, Long delay, ApiCallback<List<EmailPreview>> _callback) Wait for and return count number of emails.
okhttp3.Call	waitForEmailCountCall(UUID inboxId, Integer count, Long timeout, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, String sort, Long delay, ApiCallback _callback) Build call for waitForEmailCount
ApiResponse<List<EmailPreview>>	waitForEmailCountWithHttpInfo(UUID inboxId, Integer count, Long timeout, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, String sort, Long delay) Wait for and return count number of emails.
Email	waitForLatestEmail(UUID inboxId, Long timeout, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, String sort, Long delay) Fetch inbox's latest email or if empty wait for an email to arrive Will return either the last received email or wait for an email to arrive and return that.
okhttp3.Call	waitForLatestEmailAsync(UUID inboxId, Long timeout, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, String sort, Long delay, ApiCallback<Email> _callback) Fetch inbox's latest email or if empty wait for an email to arrive (asynchronously) Will return either the last received email or wait for an email to arrive and return that.
okhttp3.Call	waitForLatestEmailCall(UUID inboxId, Long timeout, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, String sort, Long delay, ApiCallback _callback) Build call for waitForLatestEmail
ApiResponse<Email>	waitForLatestEmailWithHttpInfo(UUID inboxId, Long timeout, Boolean unreadOnly, OffsetDateTime before, OffsetDateTime since, String sort, Long delay) Fetch inbox's latest email or if empty wait for an email to arrive Will return either the last received email or wait for an email to arrive and return that.
SmsDto	waitForLatestSms(WaitForSingleSmsOptions waitForSingleSmsOptions) Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.
okhttp3.Call	waitForLatestSmsAsync(WaitForSingleSmsOptions waitForSingleSmsOptions, ApiCallback<SmsDto> _callback) Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.
okhttp3.Call	waitForLatestSmsCall(WaitForSingleSmsOptions waitForSingleSmsOptions, ApiCallback _callback) Build call for waitForLatestSms
ApiResponse<SmsDto>	waitForLatestSmsWithHttpInfo(WaitForSingleSmsOptions waitForSingleSmsOptions) Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.
List<EmailPreview>	waitForMatchingEmails(UUID inboxId, Integer count, MatchOptions matchOptions, OffsetDateTime before, OffsetDateTime since, String sort, Long delay, Long timeout, Boolean unreadOnly) Wait or return list of emails that match simple matching patterns Perform a search of emails in an inbox with the given patterns.
okhttp3.Call	waitForMatchingEmailsAsync(UUID inboxId, Integer count, MatchOptions matchOptions, OffsetDateTime before, OffsetDateTime since, String sort, Long delay, Long timeout, Boolean unreadOnly, ApiCallback<List<EmailPreview>> _callback) Wait or return list of emails that match simple matching patterns (asynchronously) Perform a search of emails in an inbox with the given patterns.
okhttp3.Call	waitForMatchingEmailsCall(UUID inboxId, Integer count, MatchOptions matchOptions, OffsetDateTime before, OffsetDateTime since, String sort, Long delay, Long timeout, Boolean unreadOnly, ApiCallback _callback) Build call for waitForMatchingEmails
ApiResponse<List<EmailPreview>>	waitForMatchingEmailsWithHttpInfo(UUID inboxId, Integer count, MatchOptions matchOptions, OffsetDateTime before, OffsetDateTime since, String sort, Long delay, Long timeout, Boolean unreadOnly) Wait or return list of emails that match simple matching patterns Perform a search of emails in an inbox with the given patterns.
Email	waitForMatchingFirstEmail(UUID inboxId, MatchOptions matchOptions, Long timeout, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, String sort, Long delay) Wait for or return the first email that matches provided MatchOptions array Perform a search of emails in an inbox with the given patterns.
okhttp3.Call	waitForMatchingFirstEmailAsync(UUID inboxId, MatchOptions matchOptions, Long timeout, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, String sort, Long delay, ApiCallback<Email> _callback) Wait for or return the first email that matches provided MatchOptions array (asynchronously) Perform a search of emails in an inbox with the given patterns.
okhttp3.Call	waitForMatchingFirstEmailCall(UUID inboxId, MatchOptions matchOptions, Long timeout, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, String sort, Long delay, ApiCallback _callback) Build call for waitForMatchingFirstEmail
ApiResponse<Email>	waitForMatchingFirstEmailWithHttpInfo(UUID inboxId, MatchOptions matchOptions, Long timeout, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, String sort, Long delay) Wait for or return the first email that matches provided MatchOptions array Perform a search of emails in an inbox with the given patterns.
Email	waitForNthEmail(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, String sort, Long delay) Wait for or fetch the email with a given index in the inbox specified.
okhttp3.Call	waitForNthEmailAsync(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, String sort, Long delay, ApiCallback<Email> _callback) Wait for or fetch the email with a given index in the inbox specified.
okhttp3.Call	waitForNthEmailCall(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, String sort, Long delay, ApiCallback _callback) Build call for waitForNthEmail
ApiResponse<Email>	waitForNthEmailWithHttpInfo(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, String sort, Long delay) Wait for or fetch the email with a given index in the inbox specified.
List<SmsPreview>	waitForSms(WaitForSmsConditions waitForSmsConditions) Wait for an SMS message to match the provided filter conditions such as body contains keyword.
okhttp3.Call	waitForSmsAsync(WaitForSmsConditions waitForSmsConditions, ApiCallback<List<SmsPreview>> _callback) Wait for an SMS message to match the provided filter conditions such as body contains keyword.
okhttp3.Call	waitForSmsCall(WaitForSmsConditions waitForSmsConditions, ApiCallback _callback) Build call for waitForSms
ApiResponse<List<SmsPreview>>	waitForSmsWithHttpInfo(WaitForSmsConditions waitForSmsConditions) Wait for an SMS message to match the provided filter conditions such as body contains keyword.
ApiResponse<List<EmailPreview>>	waitForWithHttpInfo(WaitForConditions waitForConditions) Wait for an email to match the provided filter conditions such as subject contains keyword.

Methods inherited from class java.lang.Object

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

Constructor Detail

WaitForControllerApi

public WaitForControllerApi()

WaitForControllerApi

public WaitForControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

waitForCall

public okhttp3.Call waitForCall(WaitForConditions waitForConditions,
                                ApiCallback _callback)
                         throws ApiException

Build call for waitFor

Parameters:

waitForConditions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitFor

public List<EmailPreview> waitFor(WaitForConditions waitForConditions)
                           throws ApiException

Wait for an email to match the provided filter conditions such as subject contains keyword. Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

Parameters:

waitForConditions - (required)

Returns:

List<EmailPreview>

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	-

waitForWithHttpInfo

public ApiResponse<List<EmailPreview>> waitForWithHttpInfo(WaitForConditions waitForConditions)
                                                    throws ApiException

Wait for an email to match the provided filter conditions such as subject contains keyword. Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

Parameters:

waitForConditions - (required)

Returns:

ApiResponse<List<EmailPreview>>

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	-

waitForAsync

public okhttp3.Call waitForAsync(WaitForConditions waitForConditions,
                                 ApiCallback<List<EmailPreview>> _callback)
                          throws ApiException

Wait for an email to match the provided filter conditions such as subject contains keyword. (asynchronously) Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

Parameters:

waitForConditions - (required)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForEmailCountCall

public okhttp3.Call waitForEmailCountCall(UUID inboxId,
                                          Integer count,
                                          Long timeout,
                                          Boolean unreadOnly,
                                          OffsetDateTime before,
                                          OffsetDateTime since,
                                          String sort,
                                          Long delay,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for waitForEmailCount

Parameters:

inboxId - Id of the inbox we are fetching emails from (required)

count - Number of emails to wait for. Must be greater that 1 (required)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

before - Filter for emails that were received before the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForEmailCount

public List<EmailPreview> waitForEmailCount(UUID inboxId,
                                            Integer count,
                                            Long timeout,
                                            Boolean unreadOnly,
                                            OffsetDateTime before,
                                            OffsetDateTime since,
                                            String sort,
                                            Long delay)
                                     throws ApiException

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.

Parameters:

inboxId - Id of the inbox we are fetching emails from (required)

count - Number of emails to wait for. Must be greater that 1 (required)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

before - Filter for emails that were received before the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

Returns:

List<EmailPreview>

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	-

waitForEmailCountWithHttpInfo

public ApiResponse<List<EmailPreview>> waitForEmailCountWithHttpInfo(UUID inboxId,
                                                                     Integer count,
                                                                     Long timeout,
                                                                     Boolean unreadOnly,
                                                                     OffsetDateTime before,
                                                                     OffsetDateTime since,
                                                                     String sort,
                                                                     Long delay)
                                                              throws ApiException

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.

Parameters:

inboxId - Id of the inbox we are fetching emails from (required)

count - Number of emails to wait for. Must be greater that 1 (required)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

before - Filter for emails that were received before the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

Returns:

ApiResponse<List<EmailPreview>>

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	-

waitForEmailCountAsync

public okhttp3.Call waitForEmailCountAsync(UUID inboxId,
                                           Integer count,
                                           Long timeout,
                                           Boolean unreadOnly,
                                           OffsetDateTime before,
                                           OffsetDateTime since,
                                           String sort,
                                           Long delay,
                                           ApiCallback<List<EmailPreview>> _callback)
                                    throws ApiException

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs (asynchronously) If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.

Parameters:

inboxId - Id of the inbox we are fetching emails from (required)

count - Number of emails to wait for. Must be greater that 1 (required)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

before - Filter for emails that were received before the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForLatestEmailCall

public okhttp3.Call waitForLatestEmailCall(UUID inboxId,
                                           Long timeout,
                                           Boolean unreadOnly,
                                           OffsetDateTime before,
                                           OffsetDateTime since,
                                           String sort,
                                           Long delay,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for waitForLatestEmail

Parameters:

inboxId - Id of the inbox we are fetching emails from (optional)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only. (optional, default to false)

before - Filter for emails that were before after the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForLatestEmail

public Email waitForLatestEmail(UUID inboxId,
                                Long timeout,
                                Boolean unreadOnly,
                                OffsetDateTime before,
                                OffsetDateTime since,
                                String sort,
                                Long delay)
                         throws ApiException

Fetch inbox's latest email or if empty wait for an email to arrive Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.

Parameters:

inboxId - Id of the inbox we are fetching emails from (optional)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only. (optional, default to false)

before - Filter for emails that were before after the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

Returns:

Email

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	-

waitForLatestEmailWithHttpInfo

public ApiResponse<Email> waitForLatestEmailWithHttpInfo(UUID inboxId,
                                                         Long timeout,
                                                         Boolean unreadOnly,
                                                         OffsetDateTime before,
                                                         OffsetDateTime since,
                                                         String sort,
                                                         Long delay)
                                                  throws ApiException

Fetch inbox's latest email or if empty wait for an email to arrive Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.

Parameters:

inboxId - Id of the inbox we are fetching emails from (optional)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only. (optional, default to false)

before - Filter for emails that were before after the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

Returns:

ApiResponse<Email>

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	-

waitForLatestEmailAsync

public okhttp3.Call waitForLatestEmailAsync(UUID inboxId,
                                            Long timeout,
                                            Boolean unreadOnly,
                                            OffsetDateTime before,
                                            OffsetDateTime since,
                                            String sort,
                                            Long delay,
                                            ApiCallback<Email> _callback)
                                     throws ApiException

Fetch inbox's latest email or if empty wait for an email to arrive (asynchronously) Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.

Parameters:

inboxId - Id of the inbox we are fetching emails from (optional)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only. (optional, default to false)

before - Filter for emails that were before after the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForLatestSmsCall

public okhttp3.Call waitForLatestSmsCall(WaitForSingleSmsOptions waitForSingleSmsOptions,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for waitForLatestSms

Parameters:

waitForSingleSmsOptions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForLatestSms

public SmsDto waitForLatestSms(WaitForSingleSmsOptions waitForSingleSmsOptions)
                        throws ApiException

Wait for the latest SMS message to match the provided filter conditions such as body contains keyword. Wait until a phone number meets given conditions or return immediately if already met

Parameters:

waitForSingleSmsOptions - (required)

Returns:

SmsDto

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	-

waitForLatestSmsWithHttpInfo

public ApiResponse<SmsDto> waitForLatestSmsWithHttpInfo(WaitForSingleSmsOptions waitForSingleSmsOptions)
                                                 throws ApiException

Wait for the latest SMS message to match the provided filter conditions such as body contains keyword. Wait until a phone number meets given conditions or return immediately if already met

Parameters:

waitForSingleSmsOptions - (required)

Returns:

ApiResponse<SmsDto>

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	-

waitForLatestSmsAsync

public okhttp3.Call waitForLatestSmsAsync(WaitForSingleSmsOptions waitForSingleSmsOptions,
                                          ApiCallback<SmsDto> _callback)
                                   throws ApiException

Wait for the latest SMS message to match the provided filter conditions such as body contains keyword. (asynchronously) Wait until a phone number meets given conditions or return immediately if already met

Parameters:

waitForSingleSmsOptions - (required)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForMatchingEmailsCall

public okhttp3.Call waitForMatchingEmailsCall(UUID inboxId,
                                              Integer count,
                                              MatchOptions matchOptions,
                                              OffsetDateTime before,
                                              OffsetDateTime since,
                                              String sort,
                                              Long delay,
                                              Long timeout,
                                              Boolean unreadOnly,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for waitForMatchingEmails

Parameters:

inboxId - Id of the inbox we are fetching emails from (required)

count - Number of emails to wait for. Must be greater or equal to 1 (required)

matchOptions - (required)

before - Filter for emails that were received before the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForMatchingEmails

public List<EmailPreview> waitForMatchingEmails(UUID inboxId,
                                                Integer count,
                                                MatchOptions matchOptions,
                                                OffsetDateTime before,
                                                OffsetDateTime since,
                                                String sort,
                                                Long delay,
                                                Long timeout,
                                                Boolean unreadOnly)
                                         throws ApiException

Wait or return list of emails that match simple matching patterns Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.

Parameters:

inboxId - Id of the inbox we are fetching emails from (required)

count - Number of emails to wait for. Must be greater or equal to 1 (required)

matchOptions - (required)

before - Filter for emails that were received before the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

Returns:

List<EmailPreview>

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	-

waitForMatchingEmailsWithHttpInfo

public ApiResponse<List<EmailPreview>> waitForMatchingEmailsWithHttpInfo(UUID inboxId,
                                                                         Integer count,
                                                                         MatchOptions matchOptions,
                                                                         OffsetDateTime before,
                                                                         OffsetDateTime since,
                                                                         String sort,
                                                                         Long delay,
                                                                         Long timeout,
                                                                         Boolean unreadOnly)
                                                                  throws ApiException

Wait or return list of emails that match simple matching patterns Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.

Parameters:

inboxId - Id of the inbox we are fetching emails from (required)

count - Number of emails to wait for. Must be greater or equal to 1 (required)

matchOptions - (required)

before - Filter for emails that were received before the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

Returns:

ApiResponse<List<EmailPreview>>

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	-

waitForMatchingEmailsAsync

public okhttp3.Call waitForMatchingEmailsAsync(UUID inboxId,
                                               Integer count,
                                               MatchOptions matchOptions,
                                               OffsetDateTime before,
                                               OffsetDateTime since,
                                               String sort,
                                               Long delay,
                                               Long timeout,
                                               Boolean unreadOnly,
                                               ApiCallback<List<EmailPreview>> _callback)
                                        throws ApiException

Wait or return list of emails that match simple matching patterns (asynchronously) Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.

Parameters:

inboxId - Id of the inbox we are fetching emails from (required)

count - Number of emails to wait for. Must be greater or equal to 1 (required)

matchOptions - (required)

before - Filter for emails that were received before the given timestamp (optional)

since - Filter for emails that were received after the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForMatchingFirstEmailCall

public okhttp3.Call waitForMatchingFirstEmailCall(UUID inboxId,
                                                  MatchOptions matchOptions,
                                                  Long timeout,
                                                  Boolean unreadOnly,
                                                  OffsetDateTime since,
                                                  OffsetDateTime before,
                                                  String sort,
                                                  Long delay,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for waitForMatchingFirstEmail

Parameters:

inboxId - Id of the inbox we are matching an email for (required)

matchOptions - (required)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

since - Filter for emails that were received after the given timestamp (optional)

before - Filter for emails that were received before the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForMatchingFirstEmail

public Email waitForMatchingFirstEmail(UUID inboxId,
                                       MatchOptions matchOptions,
                                       Long timeout,
                                       Boolean unreadOnly,
                                       OffsetDateTime since,
                                       OffsetDateTime before,
                                       String sort,
                                       Long delay)
                                throws ApiException

Wait for or return the first email that matches provided MatchOptions array Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.

Parameters:

inboxId - Id of the inbox we are matching an email for (required)

matchOptions - (required)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

since - Filter for emails that were received after the given timestamp (optional)

before - Filter for emails that were received before the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

Returns:

Email

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	-

waitForMatchingFirstEmailWithHttpInfo

public ApiResponse<Email> waitForMatchingFirstEmailWithHttpInfo(UUID inboxId,
                                                                MatchOptions matchOptions,
                                                                Long timeout,
                                                                Boolean unreadOnly,
                                                                OffsetDateTime since,
                                                                OffsetDateTime before,
                                                                String sort,
                                                                Long delay)
                                                         throws ApiException

Wait for or return the first email that matches provided MatchOptions array Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.

Parameters:

inboxId - Id of the inbox we are matching an email for (required)

matchOptions - (required)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

since - Filter for emails that were received after the given timestamp (optional)

before - Filter for emails that were received before the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

Returns:

ApiResponse<Email>

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	-

waitForMatchingFirstEmailAsync

public okhttp3.Call waitForMatchingFirstEmailAsync(UUID inboxId,
                                                   MatchOptions matchOptions,
                                                   Long timeout,
                                                   Boolean unreadOnly,
                                                   OffsetDateTime since,
                                                   OffsetDateTime before,
                                                   String sort,
                                                   Long delay,
                                                   ApiCallback<Email> _callback)
                                            throws ApiException

Wait for or return the first email that matches provided MatchOptions array (asynchronously) Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.

Parameters:

inboxId - Id of the inbox we are matching an email for (required)

matchOptions - (required)

timeout - Max milliseconds to wait (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

since - Filter for emails that were received after the given timestamp (optional)

before - Filter for emails that were received before the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForNthEmailCall

public okhttp3.Call waitForNthEmailCall(UUID inboxId,
                                        Integer index,
                                        Long timeout,
                                        Boolean unreadOnly,
                                        OffsetDateTime since,
                                        OffsetDateTime before,
                                        String sort,
                                        Long delay,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for waitForNthEmail

Parameters:

inboxId - Id of the inbox you are fetching emails from (optional)

index - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional, default to 0)

timeout - Max milliseconds to wait for the nth email if not already present (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

since - Filter for emails that were received after the given timestamp (optional)

before - Filter for emails that were received before the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForNthEmail

public Email waitForNthEmail(UUID inboxId,
                             Integer index,
                             Long timeout,
                             Boolean unreadOnly,
                             OffsetDateTime since,
                             OffsetDateTime before,
                             String sort,
                             Long delay)
                      throws ApiException

Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur. If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.

Parameters:

inboxId - Id of the inbox you are fetching emails from (optional)

index - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional, default to 0)

timeout - Max milliseconds to wait for the nth email if not already present (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

since - Filter for emails that were received after the given timestamp (optional)

before - Filter for emails that were received before the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

Returns:

Email

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	-

waitForNthEmailWithHttpInfo

public ApiResponse<Email> waitForNthEmailWithHttpInfo(UUID inboxId,
                                                      Integer index,
                                                      Long timeout,
                                                      Boolean unreadOnly,
                                                      OffsetDateTime since,
                                                      OffsetDateTime before,
                                                      String sort,
                                                      Long delay)
                                               throws ApiException

Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur. If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.

Parameters:

inboxId - Id of the inbox you are fetching emails from (optional)

index - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional, default to 0)

timeout - Max milliseconds to wait for the nth email if not already present (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

since - Filter for emails that were received after the given timestamp (optional)

before - Filter for emails that were received before the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

Returns:

ApiResponse<Email>

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	-

waitForNthEmailAsync

public okhttp3.Call waitForNthEmailAsync(UUID inboxId,
                                         Integer index,
                                         Long timeout,
                                         Boolean unreadOnly,
                                         OffsetDateTime since,
                                         OffsetDateTime before,
                                         String sort,
                                         Long delay,
                                         ApiCallback<Email> _callback)
                                  throws ApiException

Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur. (asynchronously) If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.

Parameters:

inboxId - Id of the inbox you are fetching emails from (optional)

index - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional, default to 0)

timeout - Max milliseconds to wait for the nth email if not already present (optional)

unreadOnly - Optional filter for unread only (optional, default to false)

since - Filter for emails that were received after the given timestamp (optional)

before - Filter for emails that were received before the given timestamp (optional)

sort - Sort direction (optional)

delay - Max milliseconds delay between calls (optional)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForSmsCall

public okhttp3.Call waitForSmsCall(WaitForSmsConditions waitForSmsConditions,
                                   ApiCallback _callback)
                            throws ApiException

Build call for waitForSms

Parameters:

waitForSmsConditions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

waitForSms

public List<SmsPreview> waitForSms(WaitForSmsConditions waitForSmsConditions)
                            throws ApiException

Wait for an SMS message to match the provided filter conditions such as body contains keyword. Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met

Parameters:

waitForSmsConditions - (required)

Returns:

List<SmsPreview>

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	-

waitForSmsWithHttpInfo

public ApiResponse<List<SmsPreview>> waitForSmsWithHttpInfo(WaitForSmsConditions waitForSmsConditions)
                                                     throws ApiException

Wait for an SMS message to match the provided filter conditions such as body contains keyword. Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met

Parameters:

waitForSmsConditions - (required)

Returns:

ApiResponse<List<SmsPreview>>

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	-

waitForSmsAsync

public okhttp3.Call waitForSmsAsync(WaitForSmsConditions waitForSmsConditions,
                                    ApiCallback<List<SmsPreview>> _callback)
                             throws ApiException

Wait for an SMS message to match the provided filter conditions such as body contains keyword. (asynchronously) Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met

Parameters:

waitForSmsConditions - (required)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-