ExpiredControllerApi
in package
ExpiredControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['getExpirationDefaults' => ['application/json'], 'getExpiredInboxByInboxId' => ['application/json'], 'getExpiredInboxRecord' => ['application/json'], 'getExpiredInboxes' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getConfig() : Configuration
- getExpirationDefaults() : ExpirationDefaults
- Operation getExpirationDefaults
- getExpirationDefaultsAsync() : PromiseInterface
- Operation getExpirationDefaultsAsync
- getExpirationDefaultsAsyncWithHttpInfo() : PromiseInterface
- Operation getExpirationDefaultsAsyncWithHttpInfo
- getExpirationDefaultsRequest() : Request
- Create request for operation 'getExpirationDefaults'
- getExpirationDefaultsWithHttpInfo() : array<string|int, mixed>
- Operation getExpirationDefaultsWithHttpInfo
- getExpiredInboxByInboxId() : ExpiredInboxDto
- Operation getExpiredInboxByInboxId
- getExpiredInboxByInboxIdAsync() : PromiseInterface
- Operation getExpiredInboxByInboxIdAsync
- getExpiredInboxByInboxIdAsyncWithHttpInfo() : PromiseInterface
- Operation getExpiredInboxByInboxIdAsyncWithHttpInfo
- getExpiredInboxByInboxIdRequest() : Request
- Create request for operation 'getExpiredInboxByInboxId'
- getExpiredInboxByInboxIdWithHttpInfo() : array<string|int, mixed>
- Operation getExpiredInboxByInboxIdWithHttpInfo
- getExpiredInboxes() : PageExpiredInboxRecordProjection
- Operation getExpiredInboxes
- getExpiredInboxesAsync() : PromiseInterface
- Operation getExpiredInboxesAsync
- getExpiredInboxesAsyncWithHttpInfo() : PromiseInterface
- Operation getExpiredInboxesAsyncWithHttpInfo
- getExpiredInboxesRequest() : Request
- Create request for operation 'getExpiredInboxes'
- getExpiredInboxesWithHttpInfo() : array<string|int, mixed>
- Operation getExpiredInboxesWithHttpInfo
- getExpiredInboxRecord() : ExpiredInboxDto
- Operation getExpiredInboxRecord
- getExpiredInboxRecordAsync() : PromiseInterface
- Operation getExpiredInboxRecordAsync
- getExpiredInboxRecordAsyncWithHttpInfo() : PromiseInterface
- Operation getExpiredInboxRecordAsyncWithHttpInfo
- getExpiredInboxRecordRequest() : Request
- Create request for operation 'getExpiredInboxRecord'
- getExpiredInboxRecordWithHttpInfo() : array<string|int, mixed>
- Operation getExpiredInboxRecordWithHttpInfo
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['getExpirationDefaults' => ['application/json'], 'getExpiredInboxByInboxId' => ['application/json'], 'getExpiredInboxRecord' => ['application/json'], 'getExpiredInboxes' => ['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 —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getExpirationDefaults()
Operation getExpirationDefaults
public
getExpirationDefaults([string $contentType = self::contentTypes['getExpirationDefaults'][0] ]) : ExpirationDefaults
Get default expiration settings
Parameters
- $contentType : string = self::contentTypes['getExpirationDefaults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpirationDefaults'] to see the possible values for this operation
Tags
Return values
ExpirationDefaults —getExpirationDefaultsAsync()
Operation getExpirationDefaultsAsync
public
getExpirationDefaultsAsync([string $contentType = self::contentTypes['getExpirationDefaults'][0] ]) : PromiseInterface
Get default expiration settings
Parameters
- $contentType : string = self::contentTypes['getExpirationDefaults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpirationDefaults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExpirationDefaultsAsyncWithHttpInfo()
Operation getExpirationDefaultsAsyncWithHttpInfo
public
getExpirationDefaultsAsyncWithHttpInfo([string $contentType = self::contentTypes['getExpirationDefaults'][0] ]) : PromiseInterface
Get default expiration settings
Parameters
- $contentType : string = self::contentTypes['getExpirationDefaults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpirationDefaults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExpirationDefaultsRequest()
Create request for operation 'getExpirationDefaults'
public
getExpirationDefaultsRequest([string $contentType = self::contentTypes['getExpirationDefaults'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getExpirationDefaults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpirationDefaults'] to see the possible values for this operation
Tags
Return values
Request —getExpirationDefaultsWithHttpInfo()
Operation getExpirationDefaultsWithHttpInfo
public
getExpirationDefaultsWithHttpInfo([string $contentType = self::contentTypes['getExpirationDefaults'][0] ]) : array<string|int, mixed>
Get default expiration settings
Parameters
- $contentType : string = self::contentTypes['getExpirationDefaults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpirationDefaults'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ExpirationDefaults, HTTP status code, HTTP response headers (array of strings)
getExpiredInboxByInboxId()
Operation getExpiredInboxByInboxId
public
getExpiredInboxByInboxId(string $inbox_id[, string $contentType = self::contentTypes['getExpiredInboxByInboxId'][0] ]) : ExpiredInboxDto
Get expired inbox record for a previously existing inbox
Parameters
- $inbox_id : string
-
ID of inbox you want to retrieve (not the inbox ID) (required)
- $contentType : string = self::contentTypes['getExpiredInboxByInboxId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxByInboxId'] to see the possible values for this operation
Tags
Return values
ExpiredInboxDto —getExpiredInboxByInboxIdAsync()
Operation getExpiredInboxByInboxIdAsync
public
getExpiredInboxByInboxIdAsync(string $inbox_id[, string $contentType = self::contentTypes['getExpiredInboxByInboxId'][0] ]) : PromiseInterface
Get expired inbox record for a previously existing inbox
Parameters
- $inbox_id : string
-
ID of inbox you want to retrieve (not the inbox ID) (required)
- $contentType : string = self::contentTypes['getExpiredInboxByInboxId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxByInboxId'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExpiredInboxByInboxIdAsyncWithHttpInfo()
Operation getExpiredInboxByInboxIdAsyncWithHttpInfo
public
getExpiredInboxByInboxIdAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getExpiredInboxByInboxId'][0] ]) : PromiseInterface
Get expired inbox record for a previously existing inbox
Parameters
- $inbox_id : string
-
ID of inbox you want to retrieve (not the inbox ID) (required)
- $contentType : string = self::contentTypes['getExpiredInboxByInboxId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxByInboxId'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExpiredInboxByInboxIdRequest()
Create request for operation 'getExpiredInboxByInboxId'
public
getExpiredInboxByInboxIdRequest(string $inbox_id[, string $contentType = self::contentTypes['getExpiredInboxByInboxId'][0] ]) : Request
Parameters
- $inbox_id : string
-
ID of inbox you want to retrieve (not the inbox ID) (required)
- $contentType : string = self::contentTypes['getExpiredInboxByInboxId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxByInboxId'] to see the possible values for this operation
Tags
Return values
Request —getExpiredInboxByInboxIdWithHttpInfo()
Operation getExpiredInboxByInboxIdWithHttpInfo
public
getExpiredInboxByInboxIdWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getExpiredInboxByInboxId'][0] ]) : array<string|int, mixed>
Get expired inbox record for a previously existing inbox
Parameters
- $inbox_id : string
-
ID of inbox you want to retrieve (not the inbox ID) (required)
- $contentType : string = self::contentTypes['getExpiredInboxByInboxId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxByInboxId'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ExpiredInboxDto, HTTP status code, HTTP response headers (array of strings)
getExpiredInboxes()
Operation getExpiredInboxes
public
getExpiredInboxes(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getExpiredInboxes'][0] ]) : PageExpiredInboxRecordProjection
List records of expired inboxes
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $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['getExpiredInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxes'] to see the possible values for this operation
Tags
Return values
PageExpiredInboxRecordProjection —getExpiredInboxesAsync()
Operation getExpiredInboxesAsync
public
getExpiredInboxesAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getExpiredInboxes'][0] ]) : PromiseInterface
List records of expired inboxes
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $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['getExpiredInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExpiredInboxesAsyncWithHttpInfo()
Operation getExpiredInboxesAsyncWithHttpInfo
public
getExpiredInboxesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getExpiredInboxes'][0] ]) : PromiseInterface
List records of expired inboxes
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $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['getExpiredInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExpiredInboxesRequest()
Create request for operation 'getExpiredInboxes'
public
getExpiredInboxesRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getExpiredInboxes'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $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['getExpiredInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxes'] to see the possible values for this operation
Tags
Return values
Request —getExpiredInboxesWithHttpInfo()
Operation getExpiredInboxesWithHttpInfo
public
getExpiredInboxesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getExpiredInboxes'][0] ]) : array<string|int, mixed>
List records of expired inboxes
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $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['getExpiredInboxes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxes'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageExpiredInboxRecordProjection, HTTP status code, HTTP response headers (array of strings)
getExpiredInboxRecord()
Operation getExpiredInboxRecord
public
getExpiredInboxRecord(string $expired_id[, string $contentType = self::contentTypes['getExpiredInboxRecord'][0] ]) : ExpiredInboxDto
Get an expired inbox record
Parameters
- $expired_id : string
-
ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (required)
- $contentType : string = self::contentTypes['getExpiredInboxRecord'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxRecord'] to see the possible values for this operation
Tags
Return values
ExpiredInboxDto —getExpiredInboxRecordAsync()
Operation getExpiredInboxRecordAsync
public
getExpiredInboxRecordAsync(string $expired_id[, string $contentType = self::contentTypes['getExpiredInboxRecord'][0] ]) : PromiseInterface
Get an expired inbox record
Parameters
- $expired_id : string
-
ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (required)
- $contentType : string = self::contentTypes['getExpiredInboxRecord'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxRecord'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExpiredInboxRecordAsyncWithHttpInfo()
Operation getExpiredInboxRecordAsyncWithHttpInfo
public
getExpiredInboxRecordAsyncWithHttpInfo(string $expired_id[, string $contentType = self::contentTypes['getExpiredInboxRecord'][0] ]) : PromiseInterface
Get an expired inbox record
Parameters
- $expired_id : string
-
ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (required)
- $contentType : string = self::contentTypes['getExpiredInboxRecord'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxRecord'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExpiredInboxRecordRequest()
Create request for operation 'getExpiredInboxRecord'
public
getExpiredInboxRecordRequest(string $expired_id[, string $contentType = self::contentTypes['getExpiredInboxRecord'][0] ]) : Request
Parameters
- $expired_id : string
-
ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (required)
- $contentType : string = self::contentTypes['getExpiredInboxRecord'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxRecord'] to see the possible values for this operation
Tags
Return values
Request —getExpiredInboxRecordWithHttpInfo()
Operation getExpiredInboxRecordWithHttpInfo
public
getExpiredInboxRecordWithHttpInfo(string $expired_id[, string $contentType = self::contentTypes['getExpiredInboxRecord'][0] ]) : array<string|int, mixed>
Get an expired inbox record
Parameters
- $expired_id : string
-
ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId (required)
- $contentType : string = self::contentTypes['getExpiredInboxRecord'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExpiredInboxRecord'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ExpiredInboxDto, HTTP status code, HTTP response headers (array of strings)
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 —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options