InboxForwarderControllerApi
in package
InboxForwarderControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createNewInboxForwarder' => ['application/json'], 'deleteInboxForwarder' => ['application/json'], 'deleteInboxForwarders' => ['application/json'], 'getAllInboxForwarderEvents' => ['application/json'], 'getForwarderEvent' => ['application/json'], 'getInboxForwarder' => ['application/json'], 'getInboxForwarderEvent' => ['application/json'], 'getInboxForwarderEvents' => ['application/json'], 'getInboxForwarders' => ['application/json'], 'testInboxForwarder' => ['application/json'], 'testInboxForwardersForInbox' => ['application/json'], 'testNewInboxForwarder' => ['application/json'], 'updateInboxForwarder' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createNewInboxForwarder() : InboxForwarderDto
- Operation createNewInboxForwarder
- createNewInboxForwarderAsync() : PromiseInterface
- Operation createNewInboxForwarderAsync
- createNewInboxForwarderAsyncWithHttpInfo() : PromiseInterface
- Operation createNewInboxForwarderAsyncWithHttpInfo
- createNewInboxForwarderRequest() : Request
- Create request for operation 'createNewInboxForwarder'
- createNewInboxForwarderWithHttpInfo() : array<string|int, mixed>
- Operation createNewInboxForwarderWithHttpInfo
- deleteInboxForwarder() : void
- Operation deleteInboxForwarder
- deleteInboxForwarderAsync() : PromiseInterface
- Operation deleteInboxForwarderAsync
- deleteInboxForwarderAsyncWithHttpInfo() : PromiseInterface
- Operation deleteInboxForwarderAsyncWithHttpInfo
- deleteInboxForwarderRequest() : Request
- Create request for operation 'deleteInboxForwarder'
- deleteInboxForwarders() : void
- Operation deleteInboxForwarders
- deleteInboxForwardersAsync() : PromiseInterface
- Operation deleteInboxForwardersAsync
- deleteInboxForwardersAsyncWithHttpInfo() : PromiseInterface
- Operation deleteInboxForwardersAsyncWithHttpInfo
- deleteInboxForwardersRequest() : Request
- Create request for operation 'deleteInboxForwarders'
- deleteInboxForwardersWithHttpInfo() : array<string|int, mixed>
- Operation deleteInboxForwardersWithHttpInfo
- deleteInboxForwarderWithHttpInfo() : array<string|int, mixed>
- Operation deleteInboxForwarderWithHttpInfo
- getAllInboxForwarderEvents() : PageInboxForwarderEvents
- Operation getAllInboxForwarderEvents
- getAllInboxForwarderEventsAsync() : PromiseInterface
- Operation getAllInboxForwarderEventsAsync
- getAllInboxForwarderEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getAllInboxForwarderEventsAsyncWithHttpInfo
- getAllInboxForwarderEventsRequest() : Request
- Create request for operation 'getAllInboxForwarderEvents'
- getAllInboxForwarderEventsWithHttpInfo() : array<string|int, mixed>
- Operation getAllInboxForwarderEventsWithHttpInfo
- getConfig() : Configuration
- getForwarderEvent() : InboxForwarderEventDto
- Operation getForwarderEvent
- getForwarderEventAsync() : PromiseInterface
- Operation getForwarderEventAsync
- getForwarderEventAsyncWithHttpInfo() : PromiseInterface
- Operation getForwarderEventAsyncWithHttpInfo
- getForwarderEventRequest() : Request
- Create request for operation 'getForwarderEvent'
- getForwarderEventWithHttpInfo() : array<string|int, mixed>
- Operation getForwarderEventWithHttpInfo
- getHostIndex() : int
- Get the host index
- getInboxForwarder() : InboxForwarderDto
- Operation getInboxForwarder
- getInboxForwarderAsync() : PromiseInterface
- Operation getInboxForwarderAsync
- getInboxForwarderAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxForwarderAsyncWithHttpInfo
- getInboxForwarderEvent() : InboxForwarderEventDto
- Operation getInboxForwarderEvent
- getInboxForwarderEventAsync() : PromiseInterface
- Operation getInboxForwarderEventAsync
- getInboxForwarderEventAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxForwarderEventAsyncWithHttpInfo
- getInboxForwarderEventRequest() : Request
- Create request for operation 'getInboxForwarderEvent'
- getInboxForwarderEvents() : PageInboxForwarderEvents
- Operation getInboxForwarderEvents
- getInboxForwarderEventsAsync() : PromiseInterface
- Operation getInboxForwarderEventsAsync
- getInboxForwarderEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxForwarderEventsAsyncWithHttpInfo
- getInboxForwarderEventsRequest() : Request
- Create request for operation 'getInboxForwarderEvents'
- getInboxForwarderEventsWithHttpInfo() : array<string|int, mixed>
- Operation getInboxForwarderEventsWithHttpInfo
- getInboxForwarderEventWithHttpInfo() : array<string|int, mixed>
- Operation getInboxForwarderEventWithHttpInfo
- getInboxForwarderRequest() : Request
- Create request for operation 'getInboxForwarder'
- getInboxForwarders() : PageInboxForwarderDto
- Operation getInboxForwarders
- getInboxForwardersAsync() : PromiseInterface
- Operation getInboxForwardersAsync
- getInboxForwardersAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxForwardersAsyncWithHttpInfo
- getInboxForwardersRequest() : Request
- Create request for operation 'getInboxForwarders'
- getInboxForwardersWithHttpInfo() : array<string|int, mixed>
- Operation getInboxForwardersWithHttpInfo
- getInboxForwarderWithHttpInfo() : array<string|int, mixed>
- Operation getInboxForwarderWithHttpInfo
- setHostIndex() : void
- Set the host index
- testInboxForwarder() : InboxForwarderTestResult
- Operation testInboxForwarder
- testInboxForwarderAsync() : PromiseInterface
- Operation testInboxForwarderAsync
- testInboxForwarderAsyncWithHttpInfo() : PromiseInterface
- Operation testInboxForwarderAsyncWithHttpInfo
- testInboxForwarderRequest() : Request
- Create request for operation 'testInboxForwarder'
- testInboxForwardersForInbox() : InboxForwarderTestResult
- Operation testInboxForwardersForInbox
- testInboxForwardersForInboxAsync() : PromiseInterface
- Operation testInboxForwardersForInboxAsync
- testInboxForwardersForInboxAsyncWithHttpInfo() : PromiseInterface
- Operation testInboxForwardersForInboxAsyncWithHttpInfo
- testInboxForwardersForInboxRequest() : Request
- Create request for operation 'testInboxForwardersForInbox'
- testInboxForwardersForInboxWithHttpInfo() : array<string|int, mixed>
- Operation testInboxForwardersForInboxWithHttpInfo
- testInboxForwarderWithHttpInfo() : array<string|int, mixed>
- Operation testInboxForwarderWithHttpInfo
- testNewInboxForwarder() : InboxForwarderTestResult
- Operation testNewInboxForwarder
- testNewInboxForwarderAsync() : PromiseInterface
- Operation testNewInboxForwarderAsync
- testNewInboxForwarderAsyncWithHttpInfo() : PromiseInterface
- Operation testNewInboxForwarderAsyncWithHttpInfo
- testNewInboxForwarderRequest() : Request
- Create request for operation 'testNewInboxForwarder'
- testNewInboxForwarderWithHttpInfo() : array<string|int, mixed>
- Operation testNewInboxForwarderWithHttpInfo
- updateInboxForwarder() : InboxForwarderDto
- Operation updateInboxForwarder
- updateInboxForwarderAsync() : PromiseInterface
- Operation updateInboxForwarderAsync
- updateInboxForwarderAsyncWithHttpInfo() : PromiseInterface
- Operation updateInboxForwarderAsyncWithHttpInfo
- updateInboxForwarderRequest() : Request
- Create request for operation 'updateInboxForwarder'
- updateInboxForwarderWithHttpInfo() : array<string|int, mixed>
- Operation updateInboxForwarderWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createNewInboxForwarder' => ['application/json'], 'deleteInboxForwarder' => ['application/json'], 'deleteInboxForwarders' => ['application/json'], 'getAllInboxForwarderEvents' => ['application/json'], 'getForwarderEvent' => ['application/json'], 'getInboxForwarder' => ['application/json'], 'getInboxForwarderEvent' => ['application/json'], 'getInboxForwarderEvents' => ['application/json'], 'getInboxForwarders' => ['application/json'], 'testInboxForwarder' => ['application/json'], 'testInboxForwardersForInbox' => ['application/json'], 'testNewInboxForwarder' => ['application/json'], 'updateInboxForwarder' => ['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 —createNewInboxForwarder()
Operation createNewInboxForwarder
public
createNewInboxForwarder(string $inbox_id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['createNewInboxForwarder'][0] ]) : InboxForwarderDto
Create an inbox forwarder
Parameters
- $inbox_id : string
-
Inbox id to attach forwarder to (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
create_inbox_forwarder_options (required)
- $contentType : string = self::contentTypes['createNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
InboxForwarderDto —createNewInboxForwarderAsync()
Operation createNewInboxForwarderAsync
public
createNewInboxForwarderAsync(string $inbox_id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['createNewInboxForwarder'][0] ]) : PromiseInterface
Create an inbox forwarder
Parameters
- $inbox_id : string
-
Inbox id to attach forwarder to (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['createNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewInboxForwarderAsyncWithHttpInfo()
Operation createNewInboxForwarderAsyncWithHttpInfo
public
createNewInboxForwarderAsyncWithHttpInfo(string $inbox_id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['createNewInboxForwarder'][0] ]) : PromiseInterface
Create an inbox forwarder
Parameters
- $inbox_id : string
-
Inbox id to attach forwarder to (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['createNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewInboxForwarderRequest()
Create request for operation 'createNewInboxForwarder'
public
createNewInboxForwarderRequest(string $inbox_id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['createNewInboxForwarder'][0] ]) : Request
Parameters
- $inbox_id : string
-
Inbox id to attach forwarder to (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['createNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
Request —createNewInboxForwarderWithHttpInfo()
Operation createNewInboxForwarderWithHttpInfo
public
createNewInboxForwarderWithHttpInfo(string $inbox_id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['createNewInboxForwarder'][0] ]) : array<string|int, mixed>
Create an inbox forwarder
Parameters
- $inbox_id : string
-
Inbox id to attach forwarder to (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['createNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxForwarderDto, HTTP status code, HTTP response headers (array of strings)
deleteInboxForwarder()
Operation deleteInboxForwarder
public
deleteInboxForwarder(string $id[, string $contentType = self::contentTypes['deleteInboxForwarder'][0] ]) : void
Delete an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['deleteInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarder'] to see the possible values for this operation
Tags
Return values
void —deleteInboxForwarderAsync()
Operation deleteInboxForwarderAsync
public
deleteInboxForwarderAsync(string $id[, string $contentType = self::contentTypes['deleteInboxForwarder'][0] ]) : PromiseInterface
Delete an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['deleteInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxForwarderAsyncWithHttpInfo()
Operation deleteInboxForwarderAsyncWithHttpInfo
public
deleteInboxForwarderAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteInboxForwarder'][0] ]) : PromiseInterface
Delete an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['deleteInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxForwarderRequest()
Create request for operation 'deleteInboxForwarder'
public
deleteInboxForwarderRequest(string $id[, string $contentType = self::contentTypes['deleteInboxForwarder'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['deleteInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarder'] to see the possible values for this operation
Tags
Return values
Request —deleteInboxForwarders()
Operation deleteInboxForwarders
public
deleteInboxForwarders([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxForwarders'][0] ]) : void
Delete inbox forwarders
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach forwarder to (optional)
- $contentType : string = self::contentTypes['deleteInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarders'] to see the possible values for this operation
Tags
Return values
void —deleteInboxForwardersAsync()
Operation deleteInboxForwardersAsync
public
deleteInboxForwardersAsync([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxForwarders'][0] ]) : PromiseInterface
Delete inbox forwarders
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach forwarder to (optional)
- $contentType : string = self::contentTypes['deleteInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarders'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxForwardersAsyncWithHttpInfo()
Operation deleteInboxForwardersAsyncWithHttpInfo
public
deleteInboxForwardersAsyncWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxForwarders'][0] ]) : PromiseInterface
Delete inbox forwarders
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach forwarder to (optional)
- $contentType : string = self::contentTypes['deleteInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarders'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxForwardersRequest()
Create request for operation 'deleteInboxForwarders'
public
deleteInboxForwardersRequest([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxForwarders'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach forwarder to (optional)
- $contentType : string = self::contentTypes['deleteInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarders'] to see the possible values for this operation
Tags
Return values
Request —deleteInboxForwardersWithHttpInfo()
Operation deleteInboxForwardersWithHttpInfo
public
deleteInboxForwardersWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxForwarders'][0] ]) : array<string|int, mixed>
Delete inbox forwarders
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach forwarder to (optional)
- $contentType : string = self::contentTypes['deleteInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarders'] 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)
deleteInboxForwarderWithHttpInfo()
Operation deleteInboxForwarderWithHttpInfo
public
deleteInboxForwarderWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteInboxForwarder'][0] ]) : array<string|int, mixed>
Delete an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['deleteInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxForwarder'] 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)
getAllInboxForwarderEvents()
Operation getAllInboxForwarderEvents
public
getAllInboxForwarderEvents(int $page[, int $size = 20 ][, string $inbox_id = null ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getAllInboxForwarderEvents'][0] ]) : PageInboxForwarderEvents
Get all inbox forwarder events
Parameters
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder event list pagination (optional, default to 20)
- $inbox_id : string = null
-
Optional inbox ID to filter for (optional)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getAllInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
PageInboxForwarderEvents —getAllInboxForwarderEventsAsync()
Operation getAllInboxForwarderEventsAsync
public
getAllInboxForwarderEventsAsync(int $page[, int $size = 20 ][, string $inbox_id = null ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getAllInboxForwarderEvents'][0] ]) : PromiseInterface
Get all inbox forwarder events
Parameters
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder event list pagination (optional, default to 20)
- $inbox_id : string = null
-
Optional inbox ID to filter for (optional)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getAllInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllInboxForwarderEventsAsyncWithHttpInfo()
Operation getAllInboxForwarderEventsAsyncWithHttpInfo
public
getAllInboxForwarderEventsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $inbox_id = null ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getAllInboxForwarderEvents'][0] ]) : PromiseInterface
Get all inbox forwarder events
Parameters
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder event list pagination (optional, default to 20)
- $inbox_id : string = null
-
Optional inbox ID to filter for (optional)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getAllInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllInboxForwarderEventsRequest()
Create request for operation 'getAllInboxForwarderEvents'
public
getAllInboxForwarderEventsRequest(int $page[, int $size = 20 ][, string $inbox_id = null ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getAllInboxForwarderEvents'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder event list pagination (optional, default to 20)
- $inbox_id : string = null
-
Optional inbox ID to filter for (optional)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getAllInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
Request —getAllInboxForwarderEventsWithHttpInfo()
Operation getAllInboxForwarderEventsWithHttpInfo
public
getAllInboxForwarderEventsWithHttpInfo(int $page[, int $size = 20 ][, string $inbox_id = null ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getAllInboxForwarderEvents'][0] ]) : array<string|int, mixed>
Get all inbox forwarder events
Parameters
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder event list pagination (optional, default to 20)
- $inbox_id : string = null
-
Optional inbox ID to filter for (optional)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getAllInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageInboxForwarderEvents, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getForwarderEvent()
Operation getForwarderEvent
public
getForwarderEvent(string $event_id[, string $contentType = self::contentTypes['getForwarderEvent'][0] ]) : InboxForwarderEventDto
Get a forwarder event
Parameters
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getForwarderEvent'] to see the possible values for this operation
Tags
Return values
InboxForwarderEventDto —getForwarderEventAsync()
Operation getForwarderEventAsync
public
getForwarderEventAsync(string $event_id[, string $contentType = self::contentTypes['getForwarderEvent'][0] ]) : PromiseInterface
Get a forwarder event
Parameters
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getForwarderEvent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getForwarderEventAsyncWithHttpInfo()
Operation getForwarderEventAsyncWithHttpInfo
public
getForwarderEventAsyncWithHttpInfo(string $event_id[, string $contentType = self::contentTypes['getForwarderEvent'][0] ]) : PromiseInterface
Get a forwarder event
Parameters
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getForwarderEvent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getForwarderEventRequest()
Create request for operation 'getForwarderEvent'
public
getForwarderEventRequest(string $event_id[, string $contentType = self::contentTypes['getForwarderEvent'][0] ]) : Request
Parameters
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getForwarderEvent'] to see the possible values for this operation
Tags
Return values
Request —getForwarderEventWithHttpInfo()
Operation getForwarderEventWithHttpInfo
public
getForwarderEventWithHttpInfo(string $event_id[, string $contentType = self::contentTypes['getForwarderEvent'][0] ]) : array<string|int, mixed>
Get a forwarder event
Parameters
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getForwarderEvent'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxForwarderEventDto, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getInboxForwarder()
Operation getInboxForwarder
public
getInboxForwarder(string $id[, string $contentType = self::contentTypes['getInboxForwarder'][0] ]) : InboxForwarderDto
Get an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['getInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarder'] to see the possible values for this operation
Tags
Return values
InboxForwarderDto —getInboxForwarderAsync()
Operation getInboxForwarderAsync
public
getInboxForwarderAsync(string $id[, string $contentType = self::contentTypes['getInboxForwarder'][0] ]) : PromiseInterface
Get an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['getInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxForwarderAsyncWithHttpInfo()
Operation getInboxForwarderAsyncWithHttpInfo
public
getInboxForwarderAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxForwarder'][0] ]) : PromiseInterface
Get an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['getInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxForwarderEvent()
Operation getInboxForwarderEvent
public
getInboxForwarderEvent(string $id, string $event_id[, string $contentType = self::contentTypes['getInboxForwarderEvent'][0] ]) : InboxForwarderEventDto
Get an inbox forwarder event
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getInboxForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvent'] to see the possible values for this operation
Tags
Return values
InboxForwarderEventDto —getInboxForwarderEventAsync()
Operation getInboxForwarderEventAsync
public
getInboxForwarderEventAsync(string $id, string $event_id[, string $contentType = self::contentTypes['getInboxForwarderEvent'][0] ]) : PromiseInterface
Get an inbox forwarder event
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getInboxForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxForwarderEventAsyncWithHttpInfo()
Operation getInboxForwarderEventAsyncWithHttpInfo
public
getInboxForwarderEventAsyncWithHttpInfo(string $id, string $event_id[, string $contentType = self::contentTypes['getInboxForwarderEvent'][0] ]) : PromiseInterface
Get an inbox forwarder event
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getInboxForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxForwarderEventRequest()
Create request for operation 'getInboxForwarderEvent'
public
getInboxForwarderEventRequest(string $id, string $event_id[, string $contentType = self::contentTypes['getInboxForwarderEvent'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getInboxForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvent'] to see the possible values for this operation
Tags
Return values
Request —getInboxForwarderEvents()
Operation getInboxForwarderEvents
public
getInboxForwarderEvents(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxForwarderEvents'][0] ]) : PageInboxForwarderEvents
Get an inbox forwarder event list
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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['getInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
PageInboxForwarderEvents —getInboxForwarderEventsAsync()
Operation getInboxForwarderEventsAsync
public
getInboxForwarderEventsAsync(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxForwarderEvents'][0] ]) : PromiseInterface
Get an inbox forwarder event list
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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['getInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxForwarderEventsAsyncWithHttpInfo()
Operation getInboxForwarderEventsAsyncWithHttpInfo
public
getInboxForwarderEventsAsyncWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxForwarderEvents'][0] ]) : PromiseInterface
Get an inbox forwarder event list
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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['getInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxForwarderEventsRequest()
Create request for operation 'getInboxForwarderEvents'
public
getInboxForwarderEventsRequest(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxForwarderEvents'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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['getInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
Request —getInboxForwarderEventsWithHttpInfo()
Operation getInboxForwarderEventsWithHttpInfo
public
getInboxForwarderEventsWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getInboxForwarderEvents'][0] ]) : array<string|int, mixed>
Get an inbox forwarder event list
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $page : int
-
Optional page index in inbox forwarder event list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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['getInboxForwarderEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageInboxForwarderEvents, HTTP status code, HTTP response headers (array of strings)
getInboxForwarderEventWithHttpInfo()
Operation getInboxForwarderEventWithHttpInfo
public
getInboxForwarderEventWithHttpInfo(string $id, string $event_id[, string $contentType = self::contentTypes['getInboxForwarderEvent'][0] ]) : array<string|int, mixed>
Get an inbox forwarder event
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $event_id : string
-
ID of inbox forwarder event (required)
- $contentType : string = self::contentTypes['getInboxForwarderEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarderEvent'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxForwarderEventDto, HTTP status code, HTTP response headers (array of strings)
getInboxForwarderRequest()
Create request for operation 'getInboxForwarder'
public
getInboxForwarderRequest(string $id[, string $contentType = self::contentTypes['getInboxForwarder'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['getInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarder'] to see the possible values for this operation
Tags
Return values
Request —getInboxForwarders()
Operation getInboxForwarders
public
getInboxForwarders([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxForwarders'][0] ]) : PageInboxForwarderDto
List inbox forwarders
Parameters
- $inbox_id : string = null
-
Optional inbox id to get forwarders from (optional)
- $page : int
-
Optional page index in inbox forwarder list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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)
- $contentType : string = self::contentTypes['getInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarders'] to see the possible values for this operation
Tags
Return values
PageInboxForwarderDto —getInboxForwardersAsync()
Operation getInboxForwardersAsync
public
getInboxForwardersAsync([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxForwarders'][0] ]) : PromiseInterface
List inbox forwarders
Parameters
- $inbox_id : string = null
-
Optional inbox id to get forwarders from (optional)
- $page : int
-
Optional page index in inbox forwarder list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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)
- $contentType : string = self::contentTypes['getInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarders'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxForwardersAsyncWithHttpInfo()
Operation getInboxForwardersAsyncWithHttpInfo
public
getInboxForwardersAsyncWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxForwarders'][0] ]) : PromiseInterface
List inbox forwarders
Parameters
- $inbox_id : string = null
-
Optional inbox id to get forwarders from (optional)
- $page : int
-
Optional page index in inbox forwarder list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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)
- $contentType : string = self::contentTypes['getInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarders'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxForwardersRequest()
Create request for operation 'getInboxForwarders'
public
getInboxForwardersRequest([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxForwarders'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inbox id to get forwarders from (optional)
- $page : int
-
Optional page index in inbox forwarder list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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)
- $contentType : string = self::contentTypes['getInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarders'] to see the possible values for this operation
Tags
Return values
Request —getInboxForwardersWithHttpInfo()
Operation getInboxForwardersWithHttpInfo
public
getInboxForwardersWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxForwarders'][0] ]) : array<string|int, mixed>
List inbox forwarders
Parameters
- $inbox_id : string = null
-
Optional inbox id to get forwarders from (optional)
- $page : int
-
Optional page index in inbox forwarder list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox forwarder 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)
- $contentType : string = self::contentTypes['getInboxForwarders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarders'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageInboxForwarderDto, HTTP status code, HTTP response headers (array of strings)
getInboxForwarderWithHttpInfo()
Operation getInboxForwarderWithHttpInfo
public
getInboxForwarderWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxForwarder'][0] ]) : array<string|int, mixed>
Get an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $contentType : string = self::contentTypes['getInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxForwarder'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxForwarderDto, 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 —testInboxForwarder()
Operation testInboxForwarder
public
testInboxForwarder(string $id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwarder'][0] ]) : InboxForwarderTestResult
Test an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
inbox_forwarder_test_options (required)
- $contentType : string = self::contentTypes['testInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwarder'] to see the possible values for this operation
Tags
Return values
InboxForwarderTestResult —testInboxForwarderAsync()
Operation testInboxForwarderAsync
public
testInboxForwarderAsync(string $id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwarder'][0] ]) : PromiseInterface
Test an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxForwarderAsyncWithHttpInfo()
Operation testInboxForwarderAsyncWithHttpInfo
public
testInboxForwarderAsyncWithHttpInfo(string $id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwarder'][0] ]) : PromiseInterface
Test an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxForwarderRequest()
Create request for operation 'testInboxForwarder'
public
testInboxForwarderRequest(string $id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwarder'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwarder'] to see the possible values for this operation
Tags
Return values
Request —testInboxForwardersForInbox()
Operation testInboxForwardersForInbox
public
testInboxForwardersForInbox(string $inbox_id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwardersForInbox'][0] ]) : InboxForwarderTestResult
Test inbox forwarders for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
inbox_forwarder_test_options (required)
- $contentType : string = self::contentTypes['testInboxForwardersForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwardersForInbox'] to see the possible values for this operation
Tags
Return values
InboxForwarderTestResult —testInboxForwardersForInboxAsync()
Operation testInboxForwardersForInboxAsync
public
testInboxForwardersForInboxAsync(string $inbox_id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwardersForInbox'][0] ]) : PromiseInterface
Test inbox forwarders for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxForwardersForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwardersForInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxForwardersForInboxAsyncWithHttpInfo()
Operation testInboxForwardersForInboxAsyncWithHttpInfo
public
testInboxForwardersForInboxAsyncWithHttpInfo(string $inbox_id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwardersForInbox'][0] ]) : PromiseInterface
Test inbox forwarders for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxForwardersForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwardersForInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxForwardersForInboxRequest()
Create request for operation 'testInboxForwardersForInbox'
public
testInboxForwardersForInboxRequest(string $inbox_id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwardersForInbox'][0] ]) : Request
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxForwardersForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwardersForInbox'] to see the possible values for this operation
Tags
Return values
Request —testInboxForwardersForInboxWithHttpInfo()
Operation testInboxForwardersForInboxWithHttpInfo
public
testInboxForwardersForInboxWithHttpInfo(string $inbox_id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwardersForInbox'][0] ]) : array<string|int, mixed>
Test inbox forwarders for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxForwardersForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwardersForInbox'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxForwarderTestResult, HTTP status code, HTTP response headers (array of strings)
testInboxForwarderWithHttpInfo()
Operation testInboxForwarderWithHttpInfo
public
testInboxForwarderWithHttpInfo(string $id, InboxForwarderTestOptions $inbox_forwarder_test_options[, string $contentType = self::contentTypes['testInboxForwarder'][0] ]) : array<string|int, mixed>
Test an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $inbox_forwarder_test_options : InboxForwarderTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxForwarder'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxForwarderTestResult, HTTP status code, HTTP response headers (array of strings)
testNewInboxForwarder()
Operation testNewInboxForwarder
public
testNewInboxForwarder(TestNewInboxForwarderOptions $test_new_inbox_forwarder_options[, string $contentType = self::contentTypes['testNewInboxForwarder'][0] ]) : InboxForwarderTestResult
Test new inbox forwarder
Parameters
- $test_new_inbox_forwarder_options : TestNewInboxForwarderOptions
-
test_new_inbox_forwarder_options (required)
- $contentType : string = self::contentTypes['testNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
InboxForwarderTestResult —testNewInboxForwarderAsync()
Operation testNewInboxForwarderAsync
public
testNewInboxForwarderAsync(TestNewInboxForwarderOptions $test_new_inbox_forwarder_options[, string $contentType = self::contentTypes['testNewInboxForwarder'][0] ]) : PromiseInterface
Test new inbox forwarder
Parameters
- $test_new_inbox_forwarder_options : TestNewInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['testNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testNewInboxForwarderAsyncWithHttpInfo()
Operation testNewInboxForwarderAsyncWithHttpInfo
public
testNewInboxForwarderAsyncWithHttpInfo(TestNewInboxForwarderOptions $test_new_inbox_forwarder_options[, string $contentType = self::contentTypes['testNewInboxForwarder'][0] ]) : PromiseInterface
Test new inbox forwarder
Parameters
- $test_new_inbox_forwarder_options : TestNewInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['testNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testNewInboxForwarderRequest()
Create request for operation 'testNewInboxForwarder'
public
testNewInboxForwarderRequest(TestNewInboxForwarderOptions $test_new_inbox_forwarder_options[, string $contentType = self::contentTypes['testNewInboxForwarder'][0] ]) : Request
Parameters
- $test_new_inbox_forwarder_options : TestNewInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['testNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
Request —testNewInboxForwarderWithHttpInfo()
Operation testNewInboxForwarderWithHttpInfo
public
testNewInboxForwarderWithHttpInfo(TestNewInboxForwarderOptions $test_new_inbox_forwarder_options[, string $contentType = self::contentTypes['testNewInboxForwarder'][0] ]) : array<string|int, mixed>
Test new inbox forwarder
Parameters
- $test_new_inbox_forwarder_options : TestNewInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['testNewInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxForwarder'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxForwarderTestResult, HTTP status code, HTTP response headers (array of strings)
updateInboxForwarder()
Operation updateInboxForwarder
public
updateInboxForwarder(string $id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['updateInboxForwarder'][0] ]) : InboxForwarderDto
Update an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
create_inbox_forwarder_options (required)
- $contentType : string = self::contentTypes['updateInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxForwarder'] to see the possible values for this operation
Tags
Return values
InboxForwarderDto —updateInboxForwarderAsync()
Operation updateInboxForwarderAsync
public
updateInboxForwarderAsync(string $id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['updateInboxForwarder'][0] ]) : PromiseInterface
Update an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateInboxForwarderAsyncWithHttpInfo()
Operation updateInboxForwarderAsyncWithHttpInfo
public
updateInboxForwarderAsyncWithHttpInfo(string $id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['updateInboxForwarder'][0] ]) : PromiseInterface
Update an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxForwarder'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateInboxForwarderRequest()
Create request for operation 'updateInboxForwarder'
public
updateInboxForwarderRequest(string $id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['updateInboxForwarder'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxForwarder'] to see the possible values for this operation
Tags
Return values
Request —updateInboxForwarderWithHttpInfo()
Operation updateInboxForwarderWithHttpInfo
public
updateInboxForwarderWithHttpInfo(string $id, CreateInboxForwarderOptions $create_inbox_forwarder_options[, string $contentType = self::contentTypes['updateInboxForwarder'][0] ]) : array<string|int, mixed>
Update an inbox forwarder
Parameters
- $id : string
-
ID of inbox forwarder (required)
- $create_inbox_forwarder_options : CreateInboxForwarderOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxForwarder'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxForwarder'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxForwarderDto, 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