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()
void	setApiClient(ApiClient apiClient)
List<EmailPreview>	waitFor(WaitForConditions waitForConditions) Wait for conditions to be met Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
okhttp3.Call	waitForAsync(WaitForConditions waitForConditions, ApiCallback<List<EmailPreview>> _callback) Wait for conditions to be met (asynchronously) Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
okhttp3.Call	waitForCall(WaitForConditions waitForConditions, ApiCallback _callback) Build call for waitFor
List<EmailPreview>	waitForEmailCount(Integer count, UUID inboxId, Long timeout, Boolean unreadOnly) Wait for and return count number of emails If inbox contains count or more emails at time of request then return count worth of emails.
okhttp3.Call	waitForEmailCountAsync(Integer count, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback<List<EmailPreview>> _callback) Wait for and return count number of emails (asynchronously) If inbox contains count or more emails at time of request then return count worth of emails.
okhttp3.Call	waitForEmailCountCall(Integer count, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback _callback) Build call for waitForEmailCount
ApiResponse<List<EmailPreview>>	waitForEmailCountWithHttpInfo(Integer count, UUID inboxId, Long timeout, Boolean unreadOnly) Wait for and return count number of emails If inbox contains count or more emails at time of request then return count worth of emails.
Email	waitForLatestEmail(UUID inboxId, Long timeout, Boolean unreadOnly) 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, 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, ApiCallback _callback) Build call for waitForLatestEmail
ApiResponse<Email>	waitForLatestEmailWithHttpInfo(UUID inboxId, Long timeout, Boolean unreadOnly) 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.
List<EmailPreview>	waitForMatchingEmail(MatchOptions matchOptions, Integer count, UUID inboxId, 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	waitForMatchingEmailAsync(MatchOptions matchOptions, Integer count, UUID inboxId, 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	waitForMatchingEmailCall(MatchOptions matchOptions, Integer count, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback _callback) Build call for waitForMatchingEmail
ApiResponse<List<EmailPreview>>	waitForMatchingEmailWithHttpInfo(MatchOptions matchOptions, Integer count, UUID inboxId, 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(MatchOptions matchOptions, UUID inboxId, Long timeout, Boolean unreadOnly) Wait for or return the first email that matches proved MatchOptions array Perform a search of emails in an inbox with the given patterns.
okhttp3.Call	waitForMatchingFirstEmailAsync(MatchOptions matchOptions, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback<Email> _callback) Wait for or return the first email that matches proved MatchOptions array (asynchronously) Perform a search of emails in an inbox with the given patterns.
okhttp3.Call	waitForMatchingFirstEmailCall(MatchOptions matchOptions, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback _callback) Build call for waitForMatchingFirstEmail
ApiResponse<Email>	waitForMatchingFirstEmailWithHttpInfo(MatchOptions matchOptions, UUID inboxId, Long timeout, Boolean unreadOnly) Wait for or return the first email that matches proved MatchOptions array Perform a search of emails in an inbox with the given patterns.
Email	waitForNthEmail(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly) Wait for or fetch the email with a given index in the inbox specified If nth email is already present in inbox then return it.
okhttp3.Call	waitForNthEmailAsync(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly, ApiCallback<Email> _callback) Wait for or fetch the email with a given index in the inbox specified (asynchronously) If nth email is already present in inbox then return it.
okhttp3.Call	waitForNthEmailCall(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly, ApiCallback _callback) Build call for waitForNthEmail
ApiResponse<Email>	waitForNthEmailWithHttpInfo(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly) Wait for or fetch the email with a given index in the inbox specified If nth email is already present in inbox then return it.
ApiResponse<List<EmailPreview>>	waitForWithHttpInfo(WaitForConditions waitForConditions) Wait for conditions to be met Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

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)

waitForCall

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

Build call for waitFor

Parameters:

waitForConditions - Conditions to wait for (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitFor

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

Wait for conditions to be met Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

Parameters:

waitForConditions - Conditions to wait for (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForWithHttpInfo

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

Wait for conditions to be met Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

Parameters:

waitForConditions - Conditions to wait for (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForAsync

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

Wait for conditions to be met (asynchronously) Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

Parameters:

waitForConditions - Conditions to wait for (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForEmailCountCall

public okhttp3.Call waitForEmailCountCall(Integer count,
                                          UUID inboxId,
                                          Long timeout,
                                          Boolean unreadOnly,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for waitForEmailCount

Parameters:

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

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)

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForEmailCount

public List<EmailPreview> waitForEmailCount(Integer count,
                                            UUID inboxId,
                                            Long timeout,
                                            Boolean unreadOnly)
                                     throws ApiException

Wait for and return count number of emails 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:

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

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)

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForEmailCountWithHttpInfo

public ApiResponse<List<EmailPreview>> waitForEmailCountWithHttpInfo(Integer count,
                                                                     UUID inboxId,
                                                                     Long timeout,
                                                                     Boolean unreadOnly)
                                                              throws ApiException

Wait for and return count number of emails 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:

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

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)

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForEmailCountAsync

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

Wait for and return count number of emails (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:

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

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)

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForLatestEmailCall

public okhttp3.Call waitForLatestEmailCall(UUID inboxId,
                                           Long timeout,
                                           Boolean unreadOnly,
                                           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)

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForLatestEmail

public Email waitForLatestEmail(UUID inboxId,
                                Long timeout,
                                Boolean unreadOnly)
                         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)

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForLatestEmailWithHttpInfo

public ApiResponse<Email> waitForLatestEmailWithHttpInfo(UUID inboxId,
                                                         Long timeout,
                                                         Boolean unreadOnly)
                                                  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)

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForLatestEmailAsync

public okhttp3.Call waitForLatestEmailAsync(UUID inboxId,
                                            Long timeout,
                                            Boolean unreadOnly,
                                            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)

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForMatchingEmailCall

public okhttp3.Call waitForMatchingEmailCall(MatchOptions matchOptions,
                                             Integer count,
                                             UUID inboxId,
                                             Long timeout,
                                             Boolean unreadOnly,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for waitForMatchingEmail

Parameters:

matchOptions - matchOptions (required)

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

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)

_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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForMatchingEmail

public List<EmailPreview> waitForMatchingEmail(MatchOptions matchOptions,
                                               Integer count,
                                               UUID inboxId,
                                               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:

matchOptions - matchOptions (required)

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

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)

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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForMatchingEmailWithHttpInfo

public ApiResponse<List<EmailPreview>> waitForMatchingEmailWithHttpInfo(MatchOptions matchOptions,
                                                                        Integer count,
                                                                        UUID inboxId,
                                                                        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:

matchOptions - matchOptions (required)

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

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)

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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForMatchingEmailAsync

public okhttp3.Call waitForMatchingEmailAsync(MatchOptions matchOptions,
                                              Integer count,
                                              UUID inboxId,
                                              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:

matchOptions - matchOptions (required)

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

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)

_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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForMatchingFirstEmailCall

public okhttp3.Call waitForMatchingFirstEmailCall(MatchOptions matchOptions,
                                                  UUID inboxId,
                                                  Long timeout,
                                                  Boolean unreadOnly,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for waitForMatchingFirstEmail

Parameters:

matchOptions - matchOptions (required)

inboxId - Id of the inbox we are matching an email for (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForMatchingFirstEmail

public Email waitForMatchingFirstEmail(MatchOptions matchOptions,
                                       UUID inboxId,
                                       Long timeout,
                                       Boolean unreadOnly)
                                throws ApiException

Wait for or return the first email that matches proved 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:

matchOptions - matchOptions (required)

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

timeout - Max milliseconds to wait (optional)

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

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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForMatchingFirstEmailWithHttpInfo

public ApiResponse<Email> waitForMatchingFirstEmailWithHttpInfo(MatchOptions matchOptions,
                                                                UUID inboxId,
                                                                Long timeout,
                                                                Boolean unreadOnly)
                                                         throws ApiException

Wait for or return the first email that matches proved 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:

matchOptions - matchOptions (required)

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

timeout - Max milliseconds to wait (optional)

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

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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForMatchingFirstEmailAsync

public okhttp3.Call waitForMatchingFirstEmailAsync(MatchOptions matchOptions,
                                                   UUID inboxId,
                                                   Long timeout,
                                                   Boolean unreadOnly,
                                                   ApiCallback<Email> _callback)
                                            throws ApiException

Wait for or return the first email that matches proved 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:

matchOptions - matchOptions (required)

inboxId - Id of the inbox we are matching an email for (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForNthEmailCall

public okhttp3.Call waitForNthEmailCall(UUID inboxId,
                                        Integer index,
                                        Long timeout,
                                        Boolean unreadOnly,
                                        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)

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForNthEmail

public Email waitForNthEmail(UUID inboxId,
                             Integer index,
                             Long timeout,
                             Boolean unreadOnly)
                      throws ApiException

Wait for or fetch the email with a given index in the inbox specified 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)

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForNthEmailWithHttpInfo

public ApiResponse<Email> waitForNthEmailWithHttpInfo(UUID inboxId,
                                                      Integer index,
                                                      Long timeout,
                                                      Boolean unreadOnly)
                                               throws ApiException

Wait for or fetch the email with a given index in the inbox specified 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)

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

waitForNthEmailAsync

public okhttp3.Call waitForNthEmailAsync(UUID inboxId,
                                         Integer index,
                                         Long timeout,
                                         Boolean unreadOnly,
                                         ApiCallback<Email> _callback)
                                  throws ApiException

Wait for or fetch the email with a given index in the inbox specified (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)

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-