InboxReplierControllerApi
in package
InboxReplierControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createNewInboxReplier' => ['application/json'], 'deleteInboxReplier' => ['application/json'], 'deleteInboxRepliers' => ['application/json'], 'getInboxReplier' => ['application/json'], 'getInboxReplierEvents' => ['application/json'], 'getInboxRepliers' => ['application/json'], 'updateInboxReplier' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createNewInboxReplier() : InboxReplierDto
- Operation createNewInboxReplier
- createNewInboxReplierAsync() : PromiseInterface
- Operation createNewInboxReplierAsync
- createNewInboxReplierAsyncWithHttpInfo() : PromiseInterface
- Operation createNewInboxReplierAsyncWithHttpInfo
- createNewInboxReplierRequest() : Request
- Create request for operation 'createNewInboxReplier'
- createNewInboxReplierWithHttpInfo() : array<string|int, mixed>
- Operation createNewInboxReplierWithHttpInfo
- deleteInboxReplier() : void
- Operation deleteInboxReplier
- deleteInboxReplierAsync() : PromiseInterface
- Operation deleteInboxReplierAsync
- deleteInboxReplierAsyncWithHttpInfo() : PromiseInterface
- Operation deleteInboxReplierAsyncWithHttpInfo
- deleteInboxReplierRequest() : Request
- Create request for operation 'deleteInboxReplier'
- deleteInboxRepliers() : void
- Operation deleteInboxRepliers
- deleteInboxRepliersAsync() : PromiseInterface
- Operation deleteInboxRepliersAsync
- deleteInboxRepliersAsyncWithHttpInfo() : PromiseInterface
- Operation deleteInboxRepliersAsyncWithHttpInfo
- deleteInboxRepliersRequest() : Request
- Create request for operation 'deleteInboxRepliers'
- deleteInboxRepliersWithHttpInfo() : array<string|int, mixed>
- Operation deleteInboxRepliersWithHttpInfo
- deleteInboxReplierWithHttpInfo() : array<string|int, mixed>
- Operation deleteInboxReplierWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getInboxReplier() : InboxReplierDto
- Operation getInboxReplier
- getInboxReplierAsync() : PromiseInterface
- Operation getInboxReplierAsync
- getInboxReplierAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxReplierAsyncWithHttpInfo
- getInboxReplierEvents() : PageInboxReplierEvents
- Operation getInboxReplierEvents
- getInboxReplierEventsAsync() : PromiseInterface
- Operation getInboxReplierEventsAsync
- getInboxReplierEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxReplierEventsAsyncWithHttpInfo
- getInboxReplierEventsRequest() : Request
- Create request for operation 'getInboxReplierEvents'
- getInboxReplierEventsWithHttpInfo() : array<string|int, mixed>
- Operation getInboxReplierEventsWithHttpInfo
- getInboxReplierRequest() : Request
- Create request for operation 'getInboxReplier'
- getInboxRepliers() : PageInboxReplierDto
- Operation getInboxRepliers
- getInboxRepliersAsync() : PromiseInterface
- Operation getInboxRepliersAsync
- getInboxRepliersAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxRepliersAsyncWithHttpInfo
- getInboxRepliersRequest() : Request
- Create request for operation 'getInboxRepliers'
- getInboxRepliersWithHttpInfo() : array<string|int, mixed>
- Operation getInboxRepliersWithHttpInfo
- getInboxReplierWithHttpInfo() : array<string|int, mixed>
- Operation getInboxReplierWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateInboxReplier() : InboxReplierDto
- Operation updateInboxReplier
- updateInboxReplierAsync() : PromiseInterface
- Operation updateInboxReplierAsync
- updateInboxReplierAsyncWithHttpInfo() : PromiseInterface
- Operation updateInboxReplierAsyncWithHttpInfo
- updateInboxReplierRequest() : Request
- Create request for operation 'updateInboxReplier'
- updateInboxReplierWithHttpInfo() : array<string|int, mixed>
- Operation updateInboxReplierWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createNewInboxReplier' => ['application/json'], 'deleteInboxReplier' => ['application/json'], 'deleteInboxRepliers' => ['application/json'], 'getInboxReplier' => ['application/json'], 'getInboxReplierEvents' => ['application/json'], 'getInboxRepliers' => ['application/json'], 'updateInboxReplier' => ['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 —createNewInboxReplier()
Operation createNewInboxReplier
public
createNewInboxReplier(CreateInboxReplierOptions $create_inbox_replier_options[, string $contentType = self::contentTypes['createNewInboxReplier'][0] ]) : InboxReplierDto
Create an inbox replier
Parameters
- $create_inbox_replier_options : CreateInboxReplierOptions
-
create_inbox_replier_options (required)
- $contentType : string = self::contentTypes['createNewInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxReplier'] to see the possible values for this operation
Tags
Return values
InboxReplierDto —createNewInboxReplierAsync()
Operation createNewInboxReplierAsync
public
createNewInboxReplierAsync(CreateInboxReplierOptions $create_inbox_replier_options[, string $contentType = self::contentTypes['createNewInboxReplier'][0] ]) : PromiseInterface
Create an inbox replier
Parameters
- $create_inbox_replier_options : CreateInboxReplierOptions
-
(required)
- $contentType : string = self::contentTypes['createNewInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxReplier'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewInboxReplierAsyncWithHttpInfo()
Operation createNewInboxReplierAsyncWithHttpInfo
public
createNewInboxReplierAsyncWithHttpInfo(CreateInboxReplierOptions $create_inbox_replier_options[, string $contentType = self::contentTypes['createNewInboxReplier'][0] ]) : PromiseInterface
Create an inbox replier
Parameters
- $create_inbox_replier_options : CreateInboxReplierOptions
-
(required)
- $contentType : string = self::contentTypes['createNewInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxReplier'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewInboxReplierRequest()
Create request for operation 'createNewInboxReplier'
public
createNewInboxReplierRequest(CreateInboxReplierOptions $create_inbox_replier_options[, string $contentType = self::contentTypes['createNewInboxReplier'][0] ]) : Request
Parameters
- $create_inbox_replier_options : CreateInboxReplierOptions
-
(required)
- $contentType : string = self::contentTypes['createNewInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxReplier'] to see the possible values for this operation
Tags
Return values
Request —createNewInboxReplierWithHttpInfo()
Operation createNewInboxReplierWithHttpInfo
public
createNewInboxReplierWithHttpInfo(CreateInboxReplierOptions $create_inbox_replier_options[, string $contentType = self::contentTypes['createNewInboxReplier'][0] ]) : array<string|int, mixed>
Create an inbox replier
Parameters
- $create_inbox_replier_options : CreateInboxReplierOptions
-
(required)
- $contentType : string = self::contentTypes['createNewInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxReplier'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxReplierDto, HTTP status code, HTTP response headers (array of strings)
deleteInboxReplier()
Operation deleteInboxReplier
public
deleteInboxReplier(string $id[, string $contentType = self::contentTypes['deleteInboxReplier'][0] ]) : void
Delete an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['deleteInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxReplier'] to see the possible values for this operation
Tags
Return values
void —deleteInboxReplierAsync()
Operation deleteInboxReplierAsync
public
deleteInboxReplierAsync(string $id[, string $contentType = self::contentTypes['deleteInboxReplier'][0] ]) : PromiseInterface
Delete an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['deleteInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxReplier'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxReplierAsyncWithHttpInfo()
Operation deleteInboxReplierAsyncWithHttpInfo
public
deleteInboxReplierAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteInboxReplier'][0] ]) : PromiseInterface
Delete an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['deleteInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxReplier'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxReplierRequest()
Create request for operation 'deleteInboxReplier'
public
deleteInboxReplierRequest(string $id[, string $contentType = self::contentTypes['deleteInboxReplier'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['deleteInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxReplier'] to see the possible values for this operation
Tags
Return values
Request —deleteInboxRepliers()
Operation deleteInboxRepliers
public
deleteInboxRepliers([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRepliers'][0] ]) : void
Delete inbox repliers
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach replier to (optional)
- $contentType : string = self::contentTypes['deleteInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRepliers'] to see the possible values for this operation
Tags
Return values
void —deleteInboxRepliersAsync()
Operation deleteInboxRepliersAsync
public
deleteInboxRepliersAsync([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRepliers'][0] ]) : PromiseInterface
Delete inbox repliers
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach replier to (optional)
- $contentType : string = self::contentTypes['deleteInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRepliers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRepliersAsyncWithHttpInfo()
Operation deleteInboxRepliersAsyncWithHttpInfo
public
deleteInboxRepliersAsyncWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRepliers'][0] ]) : PromiseInterface
Delete inbox repliers
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach replier to (optional)
- $contentType : string = self::contentTypes['deleteInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRepliers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRepliersRequest()
Create request for operation 'deleteInboxRepliers'
public
deleteInboxRepliersRequest([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRepliers'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach replier to (optional)
- $contentType : string = self::contentTypes['deleteInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRepliers'] to see the possible values for this operation
Tags
Return values
Request —deleteInboxRepliersWithHttpInfo()
Operation deleteInboxRepliersWithHttpInfo
public
deleteInboxRepliersWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRepliers'][0] ]) : array<string|int, mixed>
Delete inbox repliers
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach replier to (optional)
- $contentType : string = self::contentTypes['deleteInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRepliers'] 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)
deleteInboxReplierWithHttpInfo()
Operation deleteInboxReplierWithHttpInfo
public
deleteInboxReplierWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteInboxReplier'][0] ]) : array<string|int, mixed>
Delete an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['deleteInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxReplier'] 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
getInboxReplier()
Operation getInboxReplier
public
getInboxReplier(string $id[, string $contentType = self::contentTypes['getInboxReplier'][0] ]) : InboxReplierDto
Get an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['getInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplier'] to see the possible values for this operation
Tags
Return values
InboxReplierDto —getInboxReplierAsync()
Operation getInboxReplierAsync
public
getInboxReplierAsync(string $id[, string $contentType = self::contentTypes['getInboxReplier'][0] ]) : PromiseInterface
Get an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['getInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplier'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxReplierAsyncWithHttpInfo()
Operation getInboxReplierAsyncWithHttpInfo
public
getInboxReplierAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxReplier'][0] ]) : PromiseInterface
Get an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['getInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplier'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxReplierEvents()
Operation getInboxReplierEvents
public
getInboxReplierEvents(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxReplierEvents'][0] ]) : PageInboxReplierEvents
Get an inbox replier event list
Parameters
- $id : string
-
ID of inbox replier (required)
- $page : int
-
Optional page index in inbox replier event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier event list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getInboxReplierEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplierEvents'] to see the possible values for this operation
Tags
Return values
PageInboxReplierEvents —getInboxReplierEventsAsync()
Operation getInboxReplierEventsAsync
public
getInboxReplierEventsAsync(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxReplierEvents'][0] ]) : PromiseInterface
Get an inbox replier event list
Parameters
- $id : string
-
ID of inbox replier (required)
- $page : int
-
Optional page index in inbox replier event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier event list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getInboxReplierEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplierEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxReplierEventsAsyncWithHttpInfo()
Operation getInboxReplierEventsAsyncWithHttpInfo
public
getInboxReplierEventsAsyncWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxReplierEvents'][0] ]) : PromiseInterface
Get an inbox replier event list
Parameters
- $id : string
-
ID of inbox replier (required)
- $page : int
-
Optional page index in inbox replier event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier event list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getInboxReplierEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplierEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxReplierEventsRequest()
Create request for operation 'getInboxReplierEvents'
public
getInboxReplierEventsRequest(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxReplierEvents'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox replier (required)
- $page : int
-
Optional page index in inbox replier event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier event list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getInboxReplierEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplierEvents'] to see the possible values for this operation
Tags
Return values
Request —getInboxReplierEventsWithHttpInfo()
Operation getInboxReplierEventsWithHttpInfo
public
getInboxReplierEventsWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxReplierEvents'][0] ]) : array<string|int, mixed>
Get an inbox replier event list
Parameters
- $id : string
-
ID of inbox replier (required)
- $page : int
-
Optional page index in inbox replier event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier event list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getInboxReplierEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplierEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageInboxReplierEvents, HTTP status code, HTTP response headers (array of strings)
getInboxReplierRequest()
Create request for operation 'getInboxReplier'
public
getInboxReplierRequest(string $id[, string $contentType = self::contentTypes['getInboxReplier'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['getInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplier'] to see the possible values for this operation
Tags
Return values
Request —getInboxRepliers()
Operation getInboxRepliers
public
getInboxRepliers([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRepliers'][0] ]) : PageInboxReplierDto
List inbox repliers
Parameters
- $inbox_id : string = null
-
Optional inbox id to get repliers from (optional)
- $page : int
-
Optional page index in inbox replier list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier 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['getInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRepliers'] to see the possible values for this operation
Tags
Return values
PageInboxReplierDto —getInboxRepliersAsync()
Operation getInboxRepliersAsync
public
getInboxRepliersAsync([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRepliers'][0] ]) : PromiseInterface
List inbox repliers
Parameters
- $inbox_id : string = null
-
Optional inbox id to get repliers from (optional)
- $page : int
-
Optional page index in inbox replier list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier 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['getInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRepliers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRepliersAsyncWithHttpInfo()
Operation getInboxRepliersAsyncWithHttpInfo
public
getInboxRepliersAsyncWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRepliers'][0] ]) : PromiseInterface
List inbox repliers
Parameters
- $inbox_id : string = null
-
Optional inbox id to get repliers from (optional)
- $page : int
-
Optional page index in inbox replier list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier 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['getInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRepliers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRepliersRequest()
Create request for operation 'getInboxRepliers'
public
getInboxRepliersRequest([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRepliers'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inbox id to get repliers from (optional)
- $page : int
-
Optional page index in inbox replier list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier 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['getInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRepliers'] to see the possible values for this operation
Tags
Return values
Request —getInboxRepliersWithHttpInfo()
Operation getInboxRepliersWithHttpInfo
public
getInboxRepliersWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRepliers'][0] ]) : array<string|int, mixed>
List inbox repliers
Parameters
- $inbox_id : string = null
-
Optional inbox id to get repliers from (optional)
- $page : int
-
Optional page index in inbox replier list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox replier 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['getInboxRepliers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRepliers'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageInboxReplierDto, HTTP status code, HTTP response headers (array of strings)
getInboxReplierWithHttpInfo()
Operation getInboxReplierWithHttpInfo
public
getInboxReplierWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxReplier'][0] ]) : array<string|int, mixed>
Get an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $contentType : string = self::contentTypes['getInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxReplier'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxReplierDto, 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 —updateInboxReplier()
Operation updateInboxReplier
public
updateInboxReplier(string $id, UpdateInboxReplierOptions $update_inbox_replier_options[, string $contentType = self::contentTypes['updateInboxReplier'][0] ]) : InboxReplierDto
Update an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $update_inbox_replier_options : UpdateInboxReplierOptions
-
update_inbox_replier_options (required)
- $contentType : string = self::contentTypes['updateInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxReplier'] to see the possible values for this operation
Tags
Return values
InboxReplierDto —updateInboxReplierAsync()
Operation updateInboxReplierAsync
public
updateInboxReplierAsync(string $id, UpdateInboxReplierOptions $update_inbox_replier_options[, string $contentType = self::contentTypes['updateInboxReplier'][0] ]) : PromiseInterface
Update an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $update_inbox_replier_options : UpdateInboxReplierOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxReplier'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateInboxReplierAsyncWithHttpInfo()
Operation updateInboxReplierAsyncWithHttpInfo
public
updateInboxReplierAsyncWithHttpInfo(string $id, UpdateInboxReplierOptions $update_inbox_replier_options[, string $contentType = self::contentTypes['updateInboxReplier'][0] ]) : PromiseInterface
Update an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $update_inbox_replier_options : UpdateInboxReplierOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxReplier'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateInboxReplierRequest()
Create request for operation 'updateInboxReplier'
public
updateInboxReplierRequest(string $id, UpdateInboxReplierOptions $update_inbox_replier_options[, string $contentType = self::contentTypes['updateInboxReplier'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox replier (required)
- $update_inbox_replier_options : UpdateInboxReplierOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxReplier'] to see the possible values for this operation
Tags
Return values
Request —updateInboxReplierWithHttpInfo()
Operation updateInboxReplierWithHttpInfo
public
updateInboxReplierWithHttpInfo(string $id, UpdateInboxReplierOptions $update_inbox_replier_options[, string $contentType = self::contentTypes['updateInboxReplier'][0] ]) : array<string|int, mixed>
Update an inbox replier
Parameters
- $id : string
-
ID of inbox replier (required)
- $update_inbox_replier_options : UpdateInboxReplierOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxReplier'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxReplier'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxReplierDto, 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