Documentation

WaitForControllerApi
in package

MailSlurp

WaitForControllerApi Class Doc Comment

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['waitFor' => ['application/json'], 'waitForEmailCount' => ['application/json'], 'waitForLatestEmail' => ['application/json'], 'waitForLatestSms' => ['application/json'], 'waitForMatchingEmails' => ['application/json'], 'waitForMatchingFirstEmail' => ['application/json'], 'waitForNthEmail' => ['application/json'], 'waitForSms' => ['application/json']]

$client


    protected
        ClientInterface
    $client

$config


    protected
        Configuration
    $config

$headerSelector


    protected
        HeaderSelector
    $headerSelector

$hostIndex


    protected
        int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values

mixed —

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration —

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

Return values

void —

waitFor()

Operation waitFor


    public
                    waitFor(WaitForConditions $wait_for_conditions[, string $contentType = self::contentTypes['waitFor'][0] ]) : array<string|int, EmailPreview>

Wait for an email to match the provided filter conditions such as subject contains keyword.

Parameters

$wait_for_conditions : WaitForConditions: wait_for_conditions (required)
$contentType : string = self::contentTypes['waitFor'][0]: The value for the Content-Type header. Check self::contentTypes['waitFor'] to see the possible values for this operation

Return values

array<string|int, EmailPreview> —

waitForAsync()

Operation waitForAsync


    public
                    waitForAsync(WaitForConditions $wait_for_conditions[, string $contentType = self::contentTypes['waitFor'][0] ]) : PromiseInterface

Wait for an email to match the provided filter conditions such as subject contains keyword.

Parameters

$wait_for_conditions : WaitForConditions: (required)
$contentType : string = self::contentTypes['waitFor'][0]: The value for the Content-Type header. Check self::contentTypes['waitFor'] to see the possible values for this operation

Return values

PromiseInterface —

waitForAsyncWithHttpInfo()

Operation waitForAsyncWithHttpInfo


    public
                    waitForAsyncWithHttpInfo(WaitForConditions $wait_for_conditions[, string $contentType = self::contentTypes['waitFor'][0] ]) : PromiseInterface

Wait for an email to match the provided filter conditions such as subject contains keyword.

Parameters

$wait_for_conditions : WaitForConditions: (required)
$contentType : string = self::contentTypes['waitFor'][0]: The value for the Content-Type header. Check self::contentTypes['waitFor'] to see the possible values for this operation

Return values

PromiseInterface —

waitForEmailCount()

Operation waitForEmailCount


    public
                    waitForEmailCount(string $inbox_id, int $count[, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForEmailCount'][0] ]) : array<string|int, EmailPreview>

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater that 1 (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['waitForEmailCount'] to see the possible values for this operation

Return values

array<string|int, EmailPreview> —

waitForEmailCountAsync()

Operation waitForEmailCountAsync


    public
                    waitForEmailCountAsync(string $inbox_id, int $count[, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForEmailCount'][0] ]) : PromiseInterface

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater that 1 (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['waitForEmailCount'] to see the possible values for this operation

Return values

PromiseInterface —

waitForEmailCountAsyncWithHttpInfo()

Operation waitForEmailCountAsyncWithHttpInfo


    public
                    waitForEmailCountAsyncWithHttpInfo(string $inbox_id, int $count[, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForEmailCount'][0] ]) : PromiseInterface

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater that 1 (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['waitForEmailCount'] to see the possible values for this operation

Return values

PromiseInterface —

waitForEmailCountRequest()

Create request for operation 'waitForEmailCount'


    public
                    waitForEmailCountRequest(string $inbox_id, int $count[, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForEmailCount'][0] ]) : Request

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater that 1 (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['waitForEmailCount'] to see the possible values for this operation

Return values

Request —

waitForEmailCountWithHttpInfo()

Operation waitForEmailCountWithHttpInfo


    public
                    waitForEmailCountWithHttpInfo(string $inbox_id, int $count[, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForEmailCount'][0] ]) : array<string|int, mixed>

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater that 1 (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['waitForEmailCount'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailPreview[], HTTP status code, HTTP response headers (array of strings)

waitForLatestEmail()

Operation waitForLatestEmail


    public
                    waitForLatestEmail([string $inbox_id = null ][, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForLatestEmail'][0] ]) : Email

Fetch inbox's latest email or if empty wait for an email to arrive

Parameters

$inbox_id : string = null: Id of the inbox we are fetching emails from (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only. (optional, default to false)
$before : DateTime = null: Filter for emails that were before after the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestEmail'] to see the possible values for this operation

Return values

Email —

waitForLatestEmailAsync()

Operation waitForLatestEmailAsync


    public
                    waitForLatestEmailAsync([string $inbox_id = null ][, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForLatestEmail'][0] ]) : PromiseInterface

Fetch inbox's latest email or if empty wait for an email to arrive

Parameters

$inbox_id : string = null: Id of the inbox we are fetching emails from (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only. (optional, default to false)
$before : DateTime = null: Filter for emails that were before after the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestEmail'] to see the possible values for this operation

Return values

PromiseInterface —

waitForLatestEmailAsyncWithHttpInfo()

Operation waitForLatestEmailAsyncWithHttpInfo


    public
                    waitForLatestEmailAsyncWithHttpInfo([string $inbox_id = null ][, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForLatestEmail'][0] ]) : PromiseInterface

Fetch inbox's latest email or if empty wait for an email to arrive

Parameters

$inbox_id : string = null: Id of the inbox we are fetching emails from (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only. (optional, default to false)
$before : DateTime = null: Filter for emails that were before after the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestEmail'] to see the possible values for this operation

Return values

PromiseInterface —

waitForLatestEmailRequest()

Create request for operation 'waitForLatestEmail'


    public
                    waitForLatestEmailRequest([string $inbox_id = null ][, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForLatestEmail'][0] ]) : Request

Parameters

$inbox_id : string = null: Id of the inbox we are fetching emails from (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only. (optional, default to false)
$before : DateTime = null: Filter for emails that were before after the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestEmail'] to see the possible values for this operation

Return values

Request —

waitForLatestEmailWithHttpInfo()

Operation waitForLatestEmailWithHttpInfo


    public
                    waitForLatestEmailWithHttpInfo([string $inbox_id = null ][, int $timeout = null ][, bool $unread_only = false ][, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForLatestEmail'][0] ]) : array<string|int, mixed>

Fetch inbox's latest email or if empty wait for an email to arrive

Parameters

$inbox_id : string = null: Id of the inbox we are fetching emails from (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only. (optional, default to false)
$before : DateTime = null: Filter for emails that were before after the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\Email, HTTP status code, HTTP response headers (array of strings)

waitForLatestSms()

Operation waitForLatestSms


    public
                    waitForLatestSms(WaitForSingleSmsOptions $wait_for_single_sms_options[, string $contentType = self::contentTypes['waitForLatestSms'][0] ]) : SmsDto

Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.

Parameters

$wait_for_single_sms_options : WaitForSingleSmsOptions: wait_for_single_sms_options (required)
$contentType : string = self::contentTypes['waitForLatestSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestSms'] to see the possible values for this operation

Return values

SmsDto —

waitForLatestSmsAsync()

Operation waitForLatestSmsAsync


    public
                    waitForLatestSmsAsync(WaitForSingleSmsOptions $wait_for_single_sms_options[, string $contentType = self::contentTypes['waitForLatestSms'][0] ]) : PromiseInterface

Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.

Parameters

$wait_for_single_sms_options : WaitForSingleSmsOptions: (required)
$contentType : string = self::contentTypes['waitForLatestSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestSms'] to see the possible values for this operation

Return values

PromiseInterface —

waitForLatestSmsAsyncWithHttpInfo()

Operation waitForLatestSmsAsyncWithHttpInfo


    public
                    waitForLatestSmsAsyncWithHttpInfo(WaitForSingleSmsOptions $wait_for_single_sms_options[, string $contentType = self::contentTypes['waitForLatestSms'][0] ]) : PromiseInterface

Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.

Parameters

$wait_for_single_sms_options : WaitForSingleSmsOptions: (required)
$contentType : string = self::contentTypes['waitForLatestSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestSms'] to see the possible values for this operation

Return values

PromiseInterface —

waitForLatestSmsRequest()

Create request for operation 'waitForLatestSms'


    public
                    waitForLatestSmsRequest(WaitForSingleSmsOptions $wait_for_single_sms_options[, string $contentType = self::contentTypes['waitForLatestSms'][0] ]) : Request

Parameters

$wait_for_single_sms_options : WaitForSingleSmsOptions: (required)
$contentType : string = self::contentTypes['waitForLatestSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestSms'] to see the possible values for this operation

Return values

Request —

waitForLatestSmsWithHttpInfo()

Operation waitForLatestSmsWithHttpInfo


    public
                    waitForLatestSmsWithHttpInfo(WaitForSingleSmsOptions $wait_for_single_sms_options[, string $contentType = self::contentTypes['waitForLatestSms'][0] ]) : array<string|int, mixed>

Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.

Parameters

$wait_for_single_sms_options : WaitForSingleSmsOptions: (required)
$contentType : string = self::contentTypes['waitForLatestSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForLatestSms'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SmsDto, HTTP status code, HTTP response headers (array of strings)

waitForMatchingEmails()

Operation waitForMatchingEmails


    public
                    waitForMatchingEmails(string $inbox_id, int $count, MatchOptions $match_options[, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, int $timeout = null ][, bool $unread_only = false ][, string $contentType = self::contentTypes['waitForMatchingEmails'][0] ]) : array<string|int, EmailPreview>

Wait or return list of emails that match simple matching patterns

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater or equal to 1 (required)
$match_options : MatchOptions: match_options (required)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$contentType : string = self::contentTypes['waitForMatchingEmails'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingEmails'] to see the possible values for this operation

Return values

array<string|int, EmailPreview> —

waitForMatchingEmailsAsync()

Operation waitForMatchingEmailsAsync


    public
                    waitForMatchingEmailsAsync(string $inbox_id, int $count, MatchOptions $match_options[, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, int $timeout = null ][, bool $unread_only = false ][, string $contentType = self::contentTypes['waitForMatchingEmails'][0] ]) : PromiseInterface

Wait or return list of emails that match simple matching patterns

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater or equal to 1 (required)
$match_options : MatchOptions: (required)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$contentType : string = self::contentTypes['waitForMatchingEmails'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingEmails'] to see the possible values for this operation

Return values

PromiseInterface —

waitForMatchingEmailsAsyncWithHttpInfo()

Operation waitForMatchingEmailsAsyncWithHttpInfo


    public
                    waitForMatchingEmailsAsyncWithHttpInfo(string $inbox_id, int $count, MatchOptions $match_options[, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, int $timeout = null ][, bool $unread_only = false ][, string $contentType = self::contentTypes['waitForMatchingEmails'][0] ]) : PromiseInterface

Wait or return list of emails that match simple matching patterns

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater or equal to 1 (required)
$match_options : MatchOptions: (required)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$contentType : string = self::contentTypes['waitForMatchingEmails'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingEmails'] to see the possible values for this operation

Return values

PromiseInterface —

waitForMatchingEmailsRequest()

Create request for operation 'waitForMatchingEmails'


    public
                    waitForMatchingEmailsRequest(string $inbox_id, int $count, MatchOptions $match_options[, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, int $timeout = null ][, bool $unread_only = false ][, string $contentType = self::contentTypes['waitForMatchingEmails'][0] ]) : Request

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater or equal to 1 (required)
$match_options : MatchOptions: (required)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$contentType : string = self::contentTypes['waitForMatchingEmails'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingEmails'] to see the possible values for this operation

Return values

Request —

waitForMatchingEmailsWithHttpInfo()

Operation waitForMatchingEmailsWithHttpInfo


    public
                    waitForMatchingEmailsWithHttpInfo(string $inbox_id, int $count, MatchOptions $match_options[, DateTime $before = null ][, DateTime $since = null ][, string $sort = null ][, int $delay = null ][, int $timeout = null ][, bool $unread_only = false ][, string $contentType = self::contentTypes['waitForMatchingEmails'][0] ]) : array<string|int, mixed>

Wait or return list of emails that match simple matching patterns

Parameters

$inbox_id : string: Id of the inbox we are fetching emails from (required)
$count : int: Number of emails to wait for. Must be greater or equal to 1 (required)
$match_options : MatchOptions: (required)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$contentType : string = self::contentTypes['waitForMatchingEmails'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingEmails'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailPreview[], HTTP status code, HTTP response headers (array of strings)

waitForMatchingFirstEmail()

Operation waitForMatchingFirstEmail


    public
                    waitForMatchingFirstEmail(string $inbox_id, MatchOptions $match_options[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForMatchingFirstEmail'][0] ]) : Email

Wait for or return the first email that matches provided MatchOptions array

Parameters

$inbox_id : string: Id of the inbox we are matching an email for (required)
$match_options : MatchOptions: match_options (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForMatchingFirstEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingFirstEmail'] to see the possible values for this operation

Return values

Email —

waitForMatchingFirstEmailAsync()

Operation waitForMatchingFirstEmailAsync


    public
                    waitForMatchingFirstEmailAsync(string $inbox_id, MatchOptions $match_options[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForMatchingFirstEmail'][0] ]) : PromiseInterface

Wait for or return the first email that matches provided MatchOptions array

Parameters

$inbox_id : string: Id of the inbox we are matching an email for (required)
$match_options : MatchOptions: (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForMatchingFirstEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingFirstEmail'] to see the possible values for this operation

Return values

PromiseInterface —

waitForMatchingFirstEmailAsyncWithHttpInfo()

Operation waitForMatchingFirstEmailAsyncWithHttpInfo


    public
                    waitForMatchingFirstEmailAsyncWithHttpInfo(string $inbox_id, MatchOptions $match_options[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForMatchingFirstEmail'][0] ]) : PromiseInterface

Wait for or return the first email that matches provided MatchOptions array

Parameters

$inbox_id : string: Id of the inbox we are matching an email for (required)
$match_options : MatchOptions: (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForMatchingFirstEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingFirstEmail'] to see the possible values for this operation

Return values

PromiseInterface —

waitForMatchingFirstEmailRequest()

Create request for operation 'waitForMatchingFirstEmail'


    public
                    waitForMatchingFirstEmailRequest(string $inbox_id, MatchOptions $match_options[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForMatchingFirstEmail'][0] ]) : Request

Parameters

$inbox_id : string: Id of the inbox we are matching an email for (required)
$match_options : MatchOptions: (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForMatchingFirstEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingFirstEmail'] to see the possible values for this operation

Return values

Request —

waitForMatchingFirstEmailWithHttpInfo()

Operation waitForMatchingFirstEmailWithHttpInfo


    public
                    waitForMatchingFirstEmailWithHttpInfo(string $inbox_id, MatchOptions $match_options[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForMatchingFirstEmail'][0] ]) : array<string|int, mixed>

Wait for or return the first email that matches provided MatchOptions array

Parameters

$inbox_id : string: Id of the inbox we are matching an email for (required)
$match_options : MatchOptions: (required)
$timeout : int = null: Max milliseconds to wait (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForMatchingFirstEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForMatchingFirstEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\Email, HTTP status code, HTTP response headers (array of strings)

waitForNthEmail()

Operation waitForNthEmail


    public
                    waitForNthEmail([string $inbox_id = null ], int $index[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForNthEmail'][0] ]) : Email

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.

Parameters

$inbox_id : string = null: Id of the inbox you are fetching emails from (optional)
$index : int: 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 : int = null: Max milliseconds to wait for the nth email if not already present (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForNthEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForNthEmail'] to see the possible values for this operation

Return values

Email —

waitForNthEmailAsync()

Operation waitForNthEmailAsync


    public
                    waitForNthEmailAsync([string $inbox_id = null ], int $index[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForNthEmail'][0] ]) : PromiseInterface

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.

Parameters

$inbox_id : string = null: Id of the inbox you are fetching emails from (optional)
$index : int: 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 : int = null: Max milliseconds to wait for the nth email if not already present (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForNthEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForNthEmail'] to see the possible values for this operation

Return values

PromiseInterface —

waitForNthEmailAsyncWithHttpInfo()

Operation waitForNthEmailAsyncWithHttpInfo


    public
                    waitForNthEmailAsyncWithHttpInfo([string $inbox_id = null ], int $index[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForNthEmail'][0] ]) : PromiseInterface

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.

Parameters

$inbox_id : string = null: Id of the inbox you are fetching emails from (optional)
$index : int: 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 : int = null: Max milliseconds to wait for the nth email if not already present (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForNthEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForNthEmail'] to see the possible values for this operation

Return values

PromiseInterface —

waitForNthEmailRequest()

Create request for operation 'waitForNthEmail'


    public
                    waitForNthEmailRequest([string $inbox_id = null ], int $index[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForNthEmail'][0] ]) : Request

Parameters

$inbox_id : string = null: Id of the inbox you are fetching emails from (optional)
$index : int: 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 : int = null: Max milliseconds to wait for the nth email if not already present (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForNthEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForNthEmail'] to see the possible values for this operation

Return values

Request —

waitForNthEmailWithHttpInfo()

Operation waitForNthEmailWithHttpInfo


    public
                    waitForNthEmailWithHttpInfo([string $inbox_id = null ], int $index[, int $timeout = null ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $sort = null ][, int $delay = null ][, string $contentType = self::contentTypes['waitForNthEmail'][0] ]) : array<string|int, mixed>

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.

Parameters

$inbox_id : string = null: Id of the inbox you are fetching emails from (optional)
$index : int: 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 : int = null: Max milliseconds to wait for the nth email if not already present (optional)
$unread_only : bool = false: Optional filter for unread only (optional, default to false)
$since : DateTime = null: Filter for emails that were received after the given timestamp (optional)
$before : DateTime = null: Filter for emails that were received before the given timestamp (optional)
$sort : string = null: Sort direction (optional)
$delay : int = null: Max milliseconds delay between calls (optional)
$contentType : string = self::contentTypes['waitForNthEmail'][0]: The value for the Content-Type header. Check self::contentTypes['waitForNthEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\Email, HTTP status code, HTTP response headers (array of strings)

waitForRequest()

Create request for operation 'waitFor'


    public
                    waitForRequest(WaitForConditions $wait_for_conditions[, string $contentType = self::contentTypes['waitFor'][0] ]) : Request

Parameters

$wait_for_conditions : WaitForConditions: (required)
$contentType : string = self::contentTypes['waitFor'][0]: The value for the Content-Type header. Check self::contentTypes['waitFor'] to see the possible values for this operation

Return values

Request —

waitForSms()

Operation waitForSms


    public
                    waitForSms(WaitForSmsConditions $wait_for_sms_conditions[, string $contentType = self::contentTypes['waitForSms'][0] ]) : array<string|int, SmsPreview>

Wait for an SMS message to match the provided filter conditions such as body contains keyword.

Parameters

$wait_for_sms_conditions : WaitForSmsConditions: wait_for_sms_conditions (required)
$contentType : string = self::contentTypes['waitForSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForSms'] to see the possible values for this operation

Return values

array<string|int, SmsPreview> —

waitForSmsAsync()

Operation waitForSmsAsync


    public
                    waitForSmsAsync(WaitForSmsConditions $wait_for_sms_conditions[, string $contentType = self::contentTypes['waitForSms'][0] ]) : PromiseInterface

Wait for an SMS message to match the provided filter conditions such as body contains keyword.

Parameters

$wait_for_sms_conditions : WaitForSmsConditions: (required)
$contentType : string = self::contentTypes['waitForSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForSms'] to see the possible values for this operation

Return values

PromiseInterface —

waitForSmsAsyncWithHttpInfo()

Operation waitForSmsAsyncWithHttpInfo


    public
                    waitForSmsAsyncWithHttpInfo(WaitForSmsConditions $wait_for_sms_conditions[, string $contentType = self::contentTypes['waitForSms'][0] ]) : PromiseInterface

Wait for an SMS message to match the provided filter conditions such as body contains keyword.

Parameters

$wait_for_sms_conditions : WaitForSmsConditions: (required)
$contentType : string = self::contentTypes['waitForSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForSms'] to see the possible values for this operation

Return values

PromiseInterface —

waitForSmsRequest()

Create request for operation 'waitForSms'


    public
                    waitForSmsRequest(WaitForSmsConditions $wait_for_sms_conditions[, string $contentType = self::contentTypes['waitForSms'][0] ]) : Request

Parameters

$wait_for_sms_conditions : WaitForSmsConditions: (required)
$contentType : string = self::contentTypes['waitForSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForSms'] to see the possible values for this operation

Return values

Request —

waitForSmsWithHttpInfo()

Operation waitForSmsWithHttpInfo


    public
                    waitForSmsWithHttpInfo(WaitForSmsConditions $wait_for_sms_conditions[, string $contentType = self::contentTypes['waitForSms'][0] ]) : array<string|int, mixed>

Wait for an SMS message to match the provided filter conditions such as body contains keyword.

Parameters

$wait_for_sms_conditions : WaitForSmsConditions: (required)
$contentType : string = self::contentTypes['waitForSms'][0]: The value for the Content-Type header. Check self::contentTypes['waitForSms'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SmsPreview[], HTTP status code, HTTP response headers (array of strings)

waitForWithHttpInfo()

Operation waitForWithHttpInfo


    public
                    waitForWithHttpInfo(WaitForConditions $wait_for_conditions[, string $contentType = self::contentTypes['waitFor'][0] ]) : array<string|int, mixed>

Wait for an email to match the provided filter conditions such as subject contains keyword.

Parameters

$wait_for_conditions : WaitForConditions: (required)
$contentType : string = self::contentTypes['waitFor'][0]: The value for the Content-Type header. Check self::contentTypes['waitFor'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailPreview[], HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

WaitForControllerApi in package MailSlurp

Tags

Table of Contents

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

Return values

getConfig()

Return values

getHostIndex()

Return values

setHostIndex()

Parameters

Return values

waitFor()

Parameters

Tags

Return values

waitForAsync()

Parameters

Tags

Return values

waitForAsyncWithHttpInfo()

Parameters

Tags

Return values

waitForEmailCount()

Parameters

Tags

Return values

waitForEmailCountAsync()

Parameters

Tags

Return values

waitForEmailCountAsyncWithHttpInfo()

Parameters

Tags

Return values

waitForEmailCountRequest()

Parameters

Tags

Return values

waitForEmailCountWithHttpInfo()

Parameters

Tags

Return values

waitForLatestEmail()

Parameters

Tags

Return values

waitForLatestEmailAsync()

Parameters

Tags

Return values

waitForLatestEmailAsyncWithHttpInfo()

Parameters

Tags

Return values

waitForLatestEmailRequest()

Parameters

Tags

Return values

waitForLatestEmailWithHttpInfo()

Parameters

Tags

Return values

waitForLatestSms()

Parameters

Tags

Return values

waitForLatestSmsAsync()

Parameters

Tags

WaitForControllerApi
in package

MailSlurp