ApiFreeInboxControllerApi
in package
ApiFreeInboxControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['create' => ['application/json'], 'delete' => ['application/json'], 'read' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- create() : CreatedFreeInboxDto
- Operation create
- createAsync() : PromiseInterface
- Operation createAsync
- createAsyncWithHttpInfo() : PromiseInterface
- Operation createAsyncWithHttpInfo
- createRequest() : Request
- Create request for operation 'create'
- createWithHttpInfo() : array<string|int, mixed>
- Operation createWithHttpInfo
- delete() : void
- Operation delete
- deleteAsync() : PromiseInterface
- Operation deleteAsync
- deleteAsyncWithHttpInfo() : PromiseInterface
- Operation deleteAsyncWithHttpInfo
- deleteRequest() : Request
- Create request for operation 'delete'
- deleteWithHttpInfo() : array<string|int, mixed>
- Operation deleteWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- read() : FreeInboxDto
- Operation read
- readAsync() : PromiseInterface
- Operation readAsync
- readAsyncWithHttpInfo() : PromiseInterface
- Operation readAsyncWithHttpInfo
- readRequest() : Request
- Create request for operation 'read'
- readWithHttpInfo() : array<string|int, mixed>
- Operation readWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['create' => ['application/json'], 'delete' => ['application/json'], 'read' => ['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 —create()
Operation create
public
create(CreateFreeInboxOptions $create_free_inbox_options[, string $contentType = self::contentTypes['create'][0] ]) : CreatedFreeInboxDto
Parameters
- $create_free_inbox_options : CreateFreeInboxOptions
-
create_free_inbox_options (required)
- $contentType : string = self::contentTypes['create'][0]
-
The value for the Content-Type header. Check self::contentTypes['create'] to see the possible values for this operation
Tags
Return values
CreatedFreeInboxDto —createAsync()
Operation createAsync
public
createAsync(CreateFreeInboxOptions $create_free_inbox_options[, string $contentType = self::contentTypes['create'][0] ]) : PromiseInterface
Parameters
- $create_free_inbox_options : CreateFreeInboxOptions
-
(required)
- $contentType : string = self::contentTypes['create'][0]
-
The value for the Content-Type header. Check self::contentTypes['create'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createAsyncWithHttpInfo()
Operation createAsyncWithHttpInfo
public
createAsyncWithHttpInfo(CreateFreeInboxOptions $create_free_inbox_options[, string $contentType = self::contentTypes['create'][0] ]) : PromiseInterface
Parameters
- $create_free_inbox_options : CreateFreeInboxOptions
-
(required)
- $contentType : string = self::contentTypes['create'][0]
-
The value for the Content-Type header. Check self::contentTypes['create'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createRequest()
Create request for operation 'create'
public
createRequest(CreateFreeInboxOptions $create_free_inbox_options[, string $contentType = self::contentTypes['create'][0] ]) : Request
Parameters
- $create_free_inbox_options : CreateFreeInboxOptions
-
(required)
- $contentType : string = self::contentTypes['create'][0]
-
The value for the Content-Type header. Check self::contentTypes['create'] to see the possible values for this operation
Tags
Return values
Request —createWithHttpInfo()
Operation createWithHttpInfo
public
createWithHttpInfo(CreateFreeInboxOptions $create_free_inbox_options[, string $contentType = self::contentTypes['create'][0] ]) : array<string|int, mixed>
Parameters
- $create_free_inbox_options : CreateFreeInboxOptions
-
(required)
- $contentType : string = self::contentTypes['create'][0]
-
The value for the Content-Type header. Check self::contentTypes['create'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CreatedFreeInboxDto, HTTP status code, HTTP response headers (array of strings)
delete()
Operation delete
public
delete(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['delete'][0] ]) : void
Parameters
- $id : string
-
id (required)
- $x_free_inbox_token : string
-
x_free_inbox_token (required)
- $contentType : string = self::contentTypes['delete'][0]
-
The value for the Content-Type header. Check self::contentTypes['delete'] to see the possible values for this operation
Tags
Return values
void —deleteAsync()
Operation deleteAsync
public
deleteAsync(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['delete'][0] ]) : PromiseInterface
Parameters
- $id : string
-
(required)
- $x_free_inbox_token : string
-
(required)
- $contentType : string = self::contentTypes['delete'][0]
-
The value for the Content-Type header. Check self::contentTypes['delete'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAsyncWithHttpInfo()
Operation deleteAsyncWithHttpInfo
public
deleteAsyncWithHttpInfo(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['delete'][0] ]) : PromiseInterface
Parameters
- $id : string
-
(required)
- $x_free_inbox_token : string
-
(required)
- $contentType : string = self::contentTypes['delete'][0]
-
The value for the Content-Type header. Check self::contentTypes['delete'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteRequest()
Create request for operation 'delete'
public
deleteRequest(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['delete'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $x_free_inbox_token : string
-
(required)
- $contentType : string = self::contentTypes['delete'][0]
-
The value for the Content-Type header. Check self::contentTypes['delete'] to see the possible values for this operation
Tags
Return values
Request —deleteWithHttpInfo()
Operation deleteWithHttpInfo
public
deleteWithHttpInfo(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['delete'][0] ]) : array<string|int, mixed>
Parameters
- $id : string
-
(required)
- $x_free_inbox_token : string
-
(required)
- $contentType : string = self::contentTypes['delete'][0]
-
The value for the Content-Type header. Check self::contentTypes['delete'] 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)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
read()
Operation read
public
read(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['read'][0] ]) : FreeInboxDto
Parameters
- $id : string
-
id (required)
- $x_free_inbox_token : string
-
x_free_inbox_token (required)
- $contentType : string = self::contentTypes['read'][0]
-
The value for the Content-Type header. Check self::contentTypes['read'] to see the possible values for this operation
Tags
Return values
FreeInboxDto —readAsync()
Operation readAsync
public
readAsync(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['read'][0] ]) : PromiseInterface
Parameters
- $id : string
-
(required)
- $x_free_inbox_token : string
-
(required)
- $contentType : string = self::contentTypes['read'][0]
-
The value for the Content-Type header. Check self::contentTypes['read'] to see the possible values for this operation
Tags
Return values
PromiseInterface —readAsyncWithHttpInfo()
Operation readAsyncWithHttpInfo
public
readAsyncWithHttpInfo(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['read'][0] ]) : PromiseInterface
Parameters
- $id : string
-
(required)
- $x_free_inbox_token : string
-
(required)
- $contentType : string = self::contentTypes['read'][0]
-
The value for the Content-Type header. Check self::contentTypes['read'] to see the possible values for this operation
Tags
Return values
PromiseInterface —readRequest()
Create request for operation 'read'
public
readRequest(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['read'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $x_free_inbox_token : string
-
(required)
- $contentType : string = self::contentTypes['read'][0]
-
The value for the Content-Type header. Check self::contentTypes['read'] to see the possible values for this operation
Tags
Return values
Request —readWithHttpInfo()
Operation readWithHttpInfo
public
readWithHttpInfo(string $id, string $x_free_inbox_token[, string $contentType = self::contentTypes['read'][0] ]) : array<string|int, mixed>
Parameters
- $id : string
-
(required)
- $x_free_inbox_token : string
-
(required)
- $contentType : string = self::contentTypes['read'][0]
-
The value for the Content-Type header. Check self::contentTypes['read'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\FreeInboxDto, 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 —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options