MissedEmailControllerApi
in package
MissedEmailControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['getAllMissedEmails' => ['application/json'], 'getAllUnknownMissedEmails' => ['application/json'], 'getMissedEmail' => ['application/json'], 'restoreMissedEmails' => ['application/json'], 'waitForNthMissedEmail' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getAllMissedEmails() : PageMissedEmailProjection
- Operation getAllMissedEmails
- getAllMissedEmailsAsync() : PromiseInterface
- Operation getAllMissedEmailsAsync
- getAllMissedEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation getAllMissedEmailsAsyncWithHttpInfo
- getAllMissedEmailsRequest() : Request
- Create request for operation 'getAllMissedEmails'
- getAllMissedEmailsWithHttpInfo() : array<string|int, mixed>
- Operation getAllMissedEmailsWithHttpInfo
- getAllUnknownMissedEmails() : PageUnknownMissedEmailProjection
- Operation getAllUnknownMissedEmails
- getAllUnknownMissedEmailsAsync() : PromiseInterface
- Operation getAllUnknownMissedEmailsAsync
- getAllUnknownMissedEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation getAllUnknownMissedEmailsAsyncWithHttpInfo
- getAllUnknownMissedEmailsRequest() : Request
- Create request for operation 'getAllUnknownMissedEmails'
- getAllUnknownMissedEmailsWithHttpInfo() : array<string|int, mixed>
- Operation getAllUnknownMissedEmailsWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getMissedEmail() : MissedEmailDto
- Operation getMissedEmail
- getMissedEmailAsync() : PromiseInterface
- Operation getMissedEmailAsync
- getMissedEmailAsyncWithHttpInfo() : PromiseInterface
- Operation getMissedEmailAsyncWithHttpInfo
- getMissedEmailRequest() : Request
- Create request for operation 'getMissedEmail'
- getMissedEmailWithHttpInfo() : array<string|int, mixed>
- Operation getMissedEmailWithHttpInfo
- restoreMissedEmails() : void
- Operation restoreMissedEmails
- restoreMissedEmailsAsync() : PromiseInterface
- Operation restoreMissedEmailsAsync
- restoreMissedEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation restoreMissedEmailsAsyncWithHttpInfo
- restoreMissedEmailsRequest() : Request
- Create request for operation 'restoreMissedEmails'
- restoreMissedEmailsWithHttpInfo() : array<string|int, mixed>
- Operation restoreMissedEmailsWithHttpInfo
- setHostIndex() : void
- Set the host index
- waitForNthMissedEmail() : MissedEmailDto
- Operation waitForNthMissedEmail
- waitForNthMissedEmailAsync() : PromiseInterface
- Operation waitForNthMissedEmailAsync
- waitForNthMissedEmailAsyncWithHttpInfo() : PromiseInterface
- Operation waitForNthMissedEmailAsyncWithHttpInfo
- waitForNthMissedEmailRequest() : Request
- Create request for operation 'waitForNthMissedEmail'
- waitForNthMissedEmailWithHttpInfo() : array<string|int, mixed>
- Operation waitForNthMissedEmailWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['getAllMissedEmails' => ['application/json'], 'getAllUnknownMissedEmails' => ['application/json'], 'getMissedEmail' => ['application/json'], 'restoreMissedEmails' => ['application/json'], 'waitForNthMissedEmail' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__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 —getAllMissedEmails()
Operation getAllMissedEmails
public
getAllMissedEmails(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllMissedEmails'][0] ]) : PageMissedEmailProjection
Get all MissedEmails in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedEmails'] to see the possible values for this operation
Tags
Return values
PageMissedEmailProjection —getAllMissedEmailsAsync()
Operation getAllMissedEmailsAsync
public
getAllMissedEmailsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllMissedEmails'][0] ]) : PromiseInterface
Get all MissedEmails in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllMissedEmailsAsyncWithHttpInfo()
Operation getAllMissedEmailsAsyncWithHttpInfo
public
getAllMissedEmailsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllMissedEmails'][0] ]) : PromiseInterface
Get all MissedEmails in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllMissedEmailsRequest()
Create request for operation 'getAllMissedEmails'
public
getAllMissedEmailsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllMissedEmails'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedEmails'] to see the possible values for this operation
Tags
Return values
Request —getAllMissedEmailsWithHttpInfo()
Operation getAllMissedEmailsWithHttpInfo
public
getAllMissedEmailsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllMissedEmails'][0] ]) : array<string|int, mixed>
Get all MissedEmails in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllMissedEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageMissedEmailProjection, HTTP status code, HTTP response headers (array of strings)
getAllUnknownMissedEmails()
Operation getAllUnknownMissedEmails
public
getAllUnknownMissedEmails(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllUnknownMissedEmails'][0] ]) : PageUnknownMissedEmailProjection
Get all unknown missed emails in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllUnknownMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllUnknownMissedEmails'] to see the possible values for this operation
Tags
Return values
PageUnknownMissedEmailProjection —getAllUnknownMissedEmailsAsync()
Operation getAllUnknownMissedEmailsAsync
public
getAllUnknownMissedEmailsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllUnknownMissedEmails'][0] ]) : PromiseInterface
Get all unknown missed emails in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllUnknownMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllUnknownMissedEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllUnknownMissedEmailsAsyncWithHttpInfo()
Operation getAllUnknownMissedEmailsAsyncWithHttpInfo
public
getAllUnknownMissedEmailsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllUnknownMissedEmails'][0] ]) : PromiseInterface
Get all unknown missed emails in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllUnknownMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllUnknownMissedEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllUnknownMissedEmailsRequest()
Create request for operation 'getAllUnknownMissedEmails'
public
getAllUnknownMissedEmailsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllUnknownMissedEmails'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllUnknownMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllUnknownMissedEmails'] to see the possible values for this operation
Tags
Return values
Request —getAllUnknownMissedEmailsWithHttpInfo()
Operation getAllUnknownMissedEmailsWithHttpInfo
public
getAllUnknownMissedEmailsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAllUnknownMissedEmails'][0] ]) : array<string|int, mixed>
Get all unknown missed emails in paginated format
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $contentType : string = self::contentTypes['getAllUnknownMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllUnknownMissedEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageUnknownMissedEmailProjection, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getMissedEmail()
Operation getMissedEmail
public
getMissedEmail(string $missed_email_id[, string $contentType = self::contentTypes['getMissedEmail'][0] ]) : MissedEmailDto
Get MissedEmail
Parameters
- $missed_email_id : string
-
missed_email_id (required)
- $contentType : string = self::contentTypes['getMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedEmail'] to see the possible values for this operation
Tags
Return values
MissedEmailDto —getMissedEmailAsync()
Operation getMissedEmailAsync
public
getMissedEmailAsync(string $missed_email_id[, string $contentType = self::contentTypes['getMissedEmail'][0] ]) : PromiseInterface
Get MissedEmail
Parameters
- $missed_email_id : string
-
(required)
- $contentType : string = self::contentTypes['getMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMissedEmailAsyncWithHttpInfo()
Operation getMissedEmailAsyncWithHttpInfo
public
getMissedEmailAsyncWithHttpInfo(string $missed_email_id[, string $contentType = self::contentTypes['getMissedEmail'][0] ]) : PromiseInterface
Get MissedEmail
Parameters
- $missed_email_id : string
-
(required)
- $contentType : string = self::contentTypes['getMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMissedEmailRequest()
Create request for operation 'getMissedEmail'
public
getMissedEmailRequest(string $missed_email_id[, string $contentType = self::contentTypes['getMissedEmail'][0] ]) : Request
Parameters
- $missed_email_id : string
-
(required)
- $contentType : string = self::contentTypes['getMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedEmail'] to see the possible values for this operation
Tags
Return values
Request —getMissedEmailWithHttpInfo()
Operation getMissedEmailWithHttpInfo
public
getMissedEmailWithHttpInfo(string $missed_email_id[, string $contentType = self::contentTypes['getMissedEmail'][0] ]) : array<string|int, mixed>
Get MissedEmail
Parameters
- $missed_email_id : string
-
(required)
- $contentType : string = self::contentTypes['getMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMissedEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\MissedEmailDto, HTTP status code, HTTP response headers (array of strings)
restoreMissedEmails()
Operation restoreMissedEmails
public
restoreMissedEmails([string $contentType = self::contentTypes['restoreMissedEmails'][0] ]) : void
Restore missed emails
Parameters
- $contentType : string = self::contentTypes['restoreMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['restoreMissedEmails'] to see the possible values for this operation
Tags
Return values
void —restoreMissedEmailsAsync()
Operation restoreMissedEmailsAsync
public
restoreMissedEmailsAsync([string $contentType = self::contentTypes['restoreMissedEmails'][0] ]) : PromiseInterface
Restore missed emails
Parameters
- $contentType : string = self::contentTypes['restoreMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['restoreMissedEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —restoreMissedEmailsAsyncWithHttpInfo()
Operation restoreMissedEmailsAsyncWithHttpInfo
public
restoreMissedEmailsAsyncWithHttpInfo([string $contentType = self::contentTypes['restoreMissedEmails'][0] ]) : PromiseInterface
Restore missed emails
Parameters
- $contentType : string = self::contentTypes['restoreMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['restoreMissedEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —restoreMissedEmailsRequest()
Create request for operation 'restoreMissedEmails'
public
restoreMissedEmailsRequest([string $contentType = self::contentTypes['restoreMissedEmails'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['restoreMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['restoreMissedEmails'] to see the possible values for this operation
Tags
Return values
Request —restoreMissedEmailsWithHttpInfo()
Operation restoreMissedEmailsWithHttpInfo
public
restoreMissedEmailsWithHttpInfo([string $contentType = self::contentTypes['restoreMissedEmails'][0] ]) : array<string|int, mixed>
Restore missed emails
Parameters
- $contentType : string = self::contentTypes['restoreMissedEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['restoreMissedEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —waitForNthMissedEmail()
Operation waitForNthMissedEmail
public
waitForNthMissedEmail(int $index[, string $inbox_id = null ][, int $timeout = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForNthMissedEmail'][0] ]) : MissedEmailDto
Wait for Nth missed email
Parameters
- $index : int
-
Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForNthMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForNthMissedEmail'] to see the possible values for this operation
Tags
Return values
MissedEmailDto —waitForNthMissedEmailAsync()
Operation waitForNthMissedEmailAsync
public
waitForNthMissedEmailAsync(int $index[, string $inbox_id = null ][, int $timeout = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForNthMissedEmail'][0] ]) : PromiseInterface
Wait for Nth missed email
Parameters
- $index : int
-
Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForNthMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForNthMissedEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —waitForNthMissedEmailAsyncWithHttpInfo()
Operation waitForNthMissedEmailAsyncWithHttpInfo
public
waitForNthMissedEmailAsyncWithHttpInfo(int $index[, string $inbox_id = null ][, int $timeout = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForNthMissedEmail'][0] ]) : PromiseInterface
Wait for Nth missed email
Parameters
- $index : int
-
Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForNthMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForNthMissedEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —waitForNthMissedEmailRequest()
Create request for operation 'waitForNthMissedEmail'
public
waitForNthMissedEmailRequest(int $index[, string $inbox_id = null ][, int $timeout = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForNthMissedEmail'][0] ]) : Request
Parameters
- $index : int
-
Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForNthMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForNthMissedEmail'] to see the possible values for this operation
Tags
Return values
Request —waitForNthMissedEmailWithHttpInfo()
Operation waitForNthMissedEmailWithHttpInfo
public
waitForNthMissedEmailWithHttpInfo(int $index[, string $inbox_id = null ][, int $timeout = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForNthMissedEmail'][0] ]) : array<string|int, mixed>
Wait for Nth missed email
Parameters
- $index : int
-
Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1 (required)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForNthMissedEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForNthMissedEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\MissedEmailDto, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options