# WaitForControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
waitFor | POST /waitFor | Wait for conditions to be met |
waitForEmailCount | GET /waitForEmailCount | Wait for and return count number of emails |
waitForLatestEmail | GET /waitForLatestEmail | Fetch inbox's latest email or if empty wait for an email to arrive |
waitForMatchingEmail | POST /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns |
waitForMatchingFirstEmail | POST /waitForMatchingFirstEmail | Wait for or return the first email that matches proved MatchOptions array |
waitForNthEmail | GET /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified |
# waitFor
List<EmailPreview> waitFor(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
# Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.WaitForControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
WaitForControllerApi apiInstance = new WaitForControllerApi(defaultClient);
WaitForConditions waitForConditions = new WaitForConditions(); // WaitForConditions | Conditions to wait for
try {
List<EmailPreview> result = apiInstance.waitFor(waitForConditions);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WaitForControllerApi#waitFor");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
waitForConditions | WaitForConditions | Conditions to wait for | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
# waitForEmailCount
List<EmailPreview> waitForEmailCount(count, inboxId, timeout, 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. If not wait until the count is reached and return those or return an error if timeout is exceeded.
# Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.WaitForControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
WaitForControllerApi apiInstance = new WaitForControllerApi(defaultClient);
Integer count = 56; // Integer | Number of emails to wait for. Must be greater that 1
UUID inboxId = new UUID(); // UUID | Id of the inbox we are fetching emails from
Long timeout = 56L; // Long | Max milliseconds to wait
Boolean unreadOnly = false; // Boolean | Optional filter for unread only
try {
List<EmailPreview> result = apiInstance.waitForEmailCount(count, inboxId, timeout, unreadOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WaitForControllerApi#waitForEmailCount");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
count | Integer | Number of emails to wait for. Must be greater that 1 | [optional] |
inboxId | UUID | Id of the inbox we are fetching emails from | [optional] |
timeout | Long | Max milliseconds to wait | [optional] |
unreadOnly | Boolean | Optional filter for unread only | [optional] [default to false] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
# waitForLatestEmail
Email waitForLatestEmail(inboxId, timeout, 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. 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`.
# Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.WaitForControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
WaitForControllerApi apiInstance = new WaitForControllerApi(defaultClient);
UUID inboxId = new UUID(); // UUID | Id of the inbox we are fetching emails from
Long timeout = 56L; // Long | Max milliseconds to wait
Boolean unreadOnly = false; // Boolean | Optional filter for unread only.
try {
Email result = apiInstance.waitForLatestEmail(inboxId, timeout, unreadOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WaitForControllerApi#waitForLatestEmail");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | UUID | Id of the inbox we are fetching emails from | [optional] |
timeout | Long | Max milliseconds to wait | [optional] |
unreadOnly | Boolean | Optional filter for unread only. | [optional] [default to false] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
# waitForMatchingEmail
List<EmailPreview> waitForMatchingEmail(matchOptions, count, inboxId, timeout, unreadOnly)
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.
# Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.WaitForControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
WaitForControllerApi apiInstance = new WaitForControllerApi(defaultClient);
MatchOptions matchOptions = new MatchOptions(); // MatchOptions | matchOptions
Integer count = 56; // Integer | Number of emails to wait for. Must be greater that 1
UUID inboxId = new UUID(); // UUID | Id of the inbox we are fetching emails from
Long timeout = 56L; // Long | Max milliseconds to wait
Boolean unreadOnly = false; // Boolean | Optional filter for unread only
try {
List<EmailPreview> result = apiInstance.waitForMatchingEmail(matchOptions, count, inboxId, timeout, unreadOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WaitForControllerApi#waitForMatchingEmail");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
matchOptions | MatchOptions | matchOptions | |
count | Integer | Number of emails to wait for. Must be greater that 1 | [optional] |
inboxId | UUID | Id of the inbox we are fetching emails from | [optional] |
timeout | Long | Max milliseconds to wait | [optional] |
unreadOnly | Boolean | Optional filter for unread only | [optional] [default to false] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
# waitForMatchingFirstEmail
Email waitForMatchingFirstEmail(matchOptions, inboxId, timeout, 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. 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.
# Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.WaitForControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
WaitForControllerApi apiInstance = new WaitForControllerApi(defaultClient);
MatchOptions matchOptions = new MatchOptions(); // MatchOptions | matchOptions
UUID inboxId = new UUID(); // UUID | Id of the inbox we are matching an email for
Long timeout = 56L; // Long | Max milliseconds to wait
Boolean unreadOnly = false; // Boolean | Optional filter for unread only
try {
Email result = apiInstance.waitForMatchingFirstEmail(matchOptions, inboxId, timeout, unreadOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WaitForControllerApi#waitForMatchingFirstEmail");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
matchOptions | MatchOptions | matchOptions | |
inboxId | UUID | Id of the inbox we are matching an email for | [optional] |
timeout | Long | Max milliseconds to wait | [optional] |
unreadOnly | Boolean | Optional filter for unread only | [optional] [default to false] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
# waitForNthEmail
Email waitForNthEmail(inboxId, index, timeout, 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. If not hold the connection open until timeout expires or the nth email is received and returned.
# Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.WaitForControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
WaitForControllerApi apiInstance = new WaitForControllerApi(defaultClient);
UUID inboxId = new UUID(); // UUID | Id of the inbox you are fetching emails from
Integer index = 0; // Integer | 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
Long timeout = 56L; // Long | Max milliseconds to wait for the nth email if not already present
Boolean unreadOnly = false; // Boolean | Optional filter for unread only
try {
Email result = apiInstance.waitForNthEmail(inboxId, index, timeout, unreadOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WaitForControllerApi#waitForNthEmail");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | UUID | Id of the inbox you are fetching emails from | [optional] |
index | Integer | 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 | Long | Max milliseconds to wait for the nth email if not already present | [optional] |
unreadOnly | Boolean | Optional filter for unread only | [optional] [default to false] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |