MailSlurpWaitForControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
waitForPOST /waitForWait for an email to match the provided filter conditions such as subject contains keyword.
waitForEmailCountGET /waitForEmailCountWait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
waitForLatestEmailGET /waitForLatestEmailFetch inbox’s latest email or if empty wait for an email to arrive
waitForMatchingEmailsPOST /waitForMatchingEmailsWait or return list of emails that match simple matching patterns
waitForMatchingFirstEmailPOST /waitForMatchingFirstEmailWait for or return the first email that matches provided MatchOptions array
waitForNthEmailGET /waitForNthEmailWait for or fetch the email with a given in the inbox specified. If doesn’t exist waits for it to exist or timeout to occur.

waitFor

MailSlurpModelsEmailPreview[] waitFor($wait_for_conditions)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiWaitForControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$wait_for_conditions = new MailSlurpModelsWaitForConditions(); // MailSlurpModelsWaitForConditions | Conditions to apply to emails that you are waiting for

try {
    $result = $apiInstance->waitFor($wait_for_conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WaitForControllerApi->waitFor: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
wait_for_conditionsMailSlurpModelsWaitForConditionsConditions to apply to emails that you are waiting for[optional]

Return type

**MailSlurpModelsEmailPreview[]**

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

waitForEmailCount

MailSlurpModelsEmailPreview[] waitForEmailCount($before, $count, $delay, $inbox_id, $since, $sort, $timeout, $unread_only)

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiWaitForControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received before the given timestamp
$count = 56; // int | Number of emails to wait for. Must be greater that 1
$delay = 56; // int | Max milliseconds delay between calls
$inbox_id = 'inbox_id_example'; // string | Id of the inbox we are fetching emails from
$since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received after the given timestamp
$sort = 'sort_example'; // string | Sort direction
$timeout = 56; // int | Max milliseconds to wait
$unread_only = false; // bool | Optional filter for unread only

try {
    $result = $apiInstance->waitForEmailCount($before, $count, $delay, $inbox_id, $since, $sort, $timeout, $unread_only);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WaitForControllerApi->waitForEmailCount: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
beforeDateTimeFilter for emails that were received before the given timestamp[optional]
countintNumber of emails to wait for. Must be greater that 1[optional]
delayintMax milliseconds delay between calls[optional]
inbox_idstringId of the inbox we are fetching emails from[optional]
sinceDateTimeFilter for emails that were received after the given timestamp[optional]
sortstringSort direction[optional]
timeoutintMax milliseconds to wait[optional]
unread_onlyboolOptional filter for unread only[optional] [default to false]

Return type

**MailSlurpModelsEmailPreview[]**

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

waitForLatestEmail

MailSlurpModelsEmail waitForLatestEmail($before, $delay, $inbox_id, $since, $sort, $timeout, $unread_only)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiWaitForControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were before after the given timestamp
$delay = 56; // int | Max milliseconds delay between calls
$inbox_id = 'inbox_id_example'; // string | Id of the inbox we are fetching emails from
$since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received after the given timestamp
$sort = 'sort_example'; // string | Sort direction
$timeout = 56; // int | Max milliseconds to wait
$unread_only = false; // bool | Optional filter for unread only.

try {
    $result = $apiInstance->waitForLatestEmail($before, $delay, $inbox_id, $since, $sort, $timeout, $unread_only);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WaitForControllerApi->waitForLatestEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
beforeDateTimeFilter for emails that were before after the given timestamp[optional]
delayintMax milliseconds delay between calls[optional]
inbox_idstringId of the inbox we are fetching emails from[optional]
sinceDateTimeFilter for emails that were received after the given timestamp[optional]
sortstringSort direction[optional]
timeoutintMax milliseconds to wait[optional]
unread_onlyboolOptional filter for unread only.[optional] [default to false]

Return type

MailSlurpModelsEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

waitForMatchingEmails

MailSlurpModelsEmailPreview[] waitForMatchingEmails($match_options, $before, $count, $delay, $inbox_id, $since, $sort, $timeout, $unread_only)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiWaitForControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$match_options = new MailSlurpModelsMatchOptions(); // MailSlurpModelsMatchOptions | matchOptions
$before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received before the given timestamp
$count = 56; // int | Number of emails to wait for. Must be greater or equal to 1
$delay = 56; // int | Max milliseconds delay between calls
$inbox_id = 'inbox_id_example'; // string | Id of the inbox we are fetching emails from
$since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received after the given timestamp
$sort = 'sort_example'; // string | Sort direction
$timeout = 56; // int | Max milliseconds to wait
$unread_only = false; // bool | Optional filter for unread only

try {
    $result = $apiInstance->waitForMatchingEmails($match_options, $before, $count, $delay, $inbox_id, $since, $sort, $timeout, $unread_only);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WaitForControllerApi->waitForMatchingEmails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
match_optionsMailSlurpModelsMatchOptionsmatchOptions
beforeDateTimeFilter for emails that were received before the given timestamp[optional]
countintNumber of emails to wait for. Must be greater or equal to 1[optional]
delayintMax milliseconds delay between calls[optional]
inbox_idstringId of the inbox we are fetching emails from[optional]
sinceDateTimeFilter for emails that were received after the given timestamp[optional]
sortstringSort direction[optional]
timeoutintMax milliseconds to wait[optional]
unread_onlyboolOptional filter for unread only[optional] [default to false]

Return type

**MailSlurpModelsEmailPreview[]**

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

waitForMatchingFirstEmail

MailSlurpModelsEmail waitForMatchingFirstEmail($match_options, $before, $delay, $inbox_id, $since, $sort, $timeout, $unread_only)

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiWaitForControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$match_options = new MailSlurpModelsMatchOptions(); // MailSlurpModelsMatchOptions | matchOptions
$before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received before the given timestamp
$delay = 56; // int | Max milliseconds delay between calls
$inbox_id = 'inbox_id_example'; // string | Id of the inbox we are matching an email for
$since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received after the given timestamp
$sort = 'sort_example'; // string | Sort direction
$timeout = 56; // int | Max milliseconds to wait
$unread_only = false; // bool | Optional filter for unread only

try {
    $result = $apiInstance->waitForMatchingFirstEmail($match_options, $before, $delay, $inbox_id, $since, $sort, $timeout, $unread_only);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WaitForControllerApi->waitForMatchingFirstEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
match_optionsMailSlurpModelsMatchOptionsmatchOptions
beforeDateTimeFilter for emails that were received before the given timestamp[optional]
delayintMax milliseconds delay between calls[optional]
inbox_idstringId of the inbox we are matching an email for[optional]
sinceDateTimeFilter for emails that were received after the given timestamp[optional]
sortstringSort direction[optional]
timeoutintMax milliseconds to wait[optional]
unread_onlyboolOptional filter for unread only[optional] [default to false]

Return type

MailSlurpModelsEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

waitForNthEmail

MailSlurpModelsEmail waitForNthEmail($before, $delay, $inbox_id, $, $since, $sort, $timeout, $unread_only)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiWaitForControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received before the given timestamp
$delay = 56; // int | Max milliseconds delay between calls
$inbox_id = 'inbox_id_example'; // string | Id of the inbox you are fetching emails from
$ = 0; // int | Zero based  of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass =1
$since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter for emails that were received after the given timestamp
$sort = 'sort_example'; // string | Sort direction
$timeout = 56; // int | Max milliseconds to wait for the nth email if not already present
$unread_only = false; // bool | Optional filter for unread only

try {
    $result = $apiInstance->waitForNthEmail($before, $delay, $inbox_id, $, $since, $sort, $timeout, $unread_only);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WaitForControllerApi->waitForNthEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
beforeDateTimeFilter for emails that were received before the given timestamp[optional]
delayintMax milliseconds delay between calls[optional]
inbox_idstringId of the inbox you are fetching emails from[optional]
****intZero based of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass =1[optional] [default to 0]
sinceDateTimeFilter for emails that were received after the given timestamp[optional]
sortstringSort direction[optional]
timeoutintMax milliseconds to wait for the nth email if not already present[optional]
unread_onlyboolOptional filter for unread only[optional] [default to false]

Return type

MailSlurpModelsEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]