MailSlurpMissedEmailControllerApi

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

MethodHTTP requestDescription
getAllMissedEmailsGET /missed-emailsGet all MissedEmails in paginated format
getMissedEmailGET /missed-emails/{missedEmailId}Get MissedEmail
waitForNthMissedEmailGET /missed-emails/waitForNthMissedEmailWait for Nth missed email

getAllMissedEmails

MailSlurpModelsPageMissedEmailProjection getAllMissedEmails($inbox_id, $page, $search_filter, $size, $sort)

Get all MissedEmails in paginated format

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 MailSlurpApiMissedEmailControllerApi(
    // 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
);
$inbox_id = 'inbox_id_example'; // string | Optional inbox ID filter
$page = 0; // int | Optional page  in list pagination
$search_filter = 'search_filter_example'; // string | Optional search filter
$size = 20; // int | Optional page size in list pagination
$sort = 'ASC'; // string | Optional createdAt sort direction ASC or DESC

try {
    $result = $apiInstance->getAllMissedEmails($inbox_id, $page, $search_filter, $size, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MissedEmailControllerApi->getAllMissedEmails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
inbox_idstringOptional inbox ID filter[optional]
pageintOptional page in list pagination[optional] [default to 0]
search_filterstringOptional search filter[optional]
sizeintOptional page size in list pagination[optional] [default to 20]
sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

MailSlurpModelsPageMissedEmailProjection

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 ]

getMissedEmail

MailSlurpModelsMissedEmail getMissedEmail($missed_email_id)

Get MissedEmail

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 MailSlurpApiMissedEmailControllerApi(
    // 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
);
$missed_email_id = 'missed_email_id_example'; // string | missedEmailId

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

Parameters

NameTypeDescriptionNotes
missed_email_idstringmissedEmailId

Return type

MailSlurpModelsMissedEmail

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 ]

waitForNthMissedEmail

MailSlurpModelsMissedEmail waitForNthMissedEmail($inbox_id, $, $timeout)

Wait for Nth missed email

Wait for 0 based missed email

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 MailSlurpApiMissedEmailControllerApi(
    // 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
);
$inbox_id = 'inbox_id_example'; // string | Optional inbox ID filter
$ = 56; // int | Zero based  of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
$timeout = 56; // int | Optional timeout milliseconds

try {
    $result = $apiInstance->waitForNthMissedEmail($inbox_id, $, $timeout);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MissedEmailControllerApi->waitForNthMissedEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
inbox_idstringOptional inbox ID filter[optional]
****intZero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1[optional]
timeoutintOptional timeout milliseconds[optional]

Return type

MailSlurpModelsMissedEmail

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 ]