ApiSendingConnectionControllerApi
in package
ApiSendingConnectionControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createSendingConnection' => ['application/json'], 'deleteDeliverySenderSeats' => ['application/json'], 'deleteSendingConnection' => ['application/json'], 'disableSendingConnection' => ['application/json'], 'enableSendingConnection' => ['application/json'], 'getDeliverySenderCapacity' => ['application/json'], 'getSendingConnection' => ['application/json'], 'getSendingConnectionProviders' => ['application/json'], 'getSendingConnections' => ['application/json'], 'probeSendingConnectionDelivery' => ['application/json'], 'rotateSendingConnectionCredentials' => ['application/json'], 'updateDeliverySenderSeats' => ['application/json'], 'updateSendingConnection' => ['application/json'], 'verifySendingConnection' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createSendingConnection() : SendingConnectionDto
- Operation createSendingConnection
- createSendingConnectionAsync() : PromiseInterface
- Operation createSendingConnectionAsync
- createSendingConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation createSendingConnectionAsyncWithHttpInfo
- createSendingConnectionRequest() : Request
- Create request for operation 'createSendingConnection'
- createSendingConnectionWithHttpInfo() : array<string|int, mixed>
- Operation createSendingConnectionWithHttpInfo
- deleteDeliverySenderSeats() : DeliverySenderCapacityDto
- Operation deleteDeliverySenderSeats
- deleteDeliverySenderSeatsAsync() : PromiseInterface
- Operation deleteDeliverySenderSeatsAsync
- deleteDeliverySenderSeatsAsyncWithHttpInfo() : PromiseInterface
- Operation deleteDeliverySenderSeatsAsyncWithHttpInfo
- deleteDeliverySenderSeatsRequest() : Request
- Create request for operation 'deleteDeliverySenderSeats'
- deleteDeliverySenderSeatsWithHttpInfo() : array<string|int, mixed>
- Operation deleteDeliverySenderSeatsWithHttpInfo
- deleteSendingConnection() : void
- Operation deleteSendingConnection
- deleteSendingConnectionAsync() : PromiseInterface
- Operation deleteSendingConnectionAsync
- deleteSendingConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation deleteSendingConnectionAsyncWithHttpInfo
- deleteSendingConnectionRequest() : Request
- Create request for operation 'deleteSendingConnection'
- deleteSendingConnectionWithHttpInfo() : array<string|int, mixed>
- Operation deleteSendingConnectionWithHttpInfo
- disableSendingConnection() : SendingConnectionDto
- Operation disableSendingConnection
- disableSendingConnectionAsync() : PromiseInterface
- Operation disableSendingConnectionAsync
- disableSendingConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation disableSendingConnectionAsyncWithHttpInfo
- disableSendingConnectionRequest() : Request
- Create request for operation 'disableSendingConnection'
- disableSendingConnectionWithHttpInfo() : array<string|int, mixed>
- Operation disableSendingConnectionWithHttpInfo
- enableSendingConnection() : SendingConnectionDto
- Operation enableSendingConnection
- enableSendingConnectionAsync() : PromiseInterface
- Operation enableSendingConnectionAsync
- enableSendingConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation enableSendingConnectionAsyncWithHttpInfo
- enableSendingConnectionRequest() : Request
- Create request for operation 'enableSendingConnection'
- enableSendingConnectionWithHttpInfo() : array<string|int, mixed>
- Operation enableSendingConnectionWithHttpInfo
- getConfig() : Configuration
- getDeliverySenderCapacity() : DeliverySenderCapacityDto
- Operation getDeliverySenderCapacity
- getDeliverySenderCapacityAsync() : PromiseInterface
- Operation getDeliverySenderCapacityAsync
- getDeliverySenderCapacityAsyncWithHttpInfo() : PromiseInterface
- Operation getDeliverySenderCapacityAsyncWithHttpInfo
- getDeliverySenderCapacityRequest() : Request
- Create request for operation 'getDeliverySenderCapacity'
- getDeliverySenderCapacityWithHttpInfo() : array<string|int, mixed>
- Operation getDeliverySenderCapacityWithHttpInfo
- getHostIndex() : int
- Get the host index
- getSendingConnection() : SendingConnectionDto
- Operation getSendingConnection
- getSendingConnectionAsync() : PromiseInterface
- Operation getSendingConnectionAsync
- getSendingConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation getSendingConnectionAsyncWithHttpInfo
- getSendingConnectionProviders() : array<string|int, SendingConnectionProviderDto>
- Operation getSendingConnectionProviders
- getSendingConnectionProvidersAsync() : PromiseInterface
- Operation getSendingConnectionProvidersAsync
- getSendingConnectionProvidersAsyncWithHttpInfo() : PromiseInterface
- Operation getSendingConnectionProvidersAsyncWithHttpInfo
- getSendingConnectionProvidersRequest() : Request
- Create request for operation 'getSendingConnectionProviders'
- getSendingConnectionProvidersWithHttpInfo() : array<string|int, mixed>
- Operation getSendingConnectionProvidersWithHttpInfo
- getSendingConnectionRequest() : Request
- Create request for operation 'getSendingConnection'
- getSendingConnections() : array<string|int, SendingConnectionDto>
- Operation getSendingConnections
- getSendingConnectionsAsync() : PromiseInterface
- Operation getSendingConnectionsAsync
- getSendingConnectionsAsyncWithHttpInfo() : PromiseInterface
- Operation getSendingConnectionsAsyncWithHttpInfo
- getSendingConnectionsRequest() : Request
- Create request for operation 'getSendingConnections'
- getSendingConnectionsWithHttpInfo() : array<string|int, mixed>
- Operation getSendingConnectionsWithHttpInfo
- getSendingConnectionWithHttpInfo() : array<string|int, mixed>
- Operation getSendingConnectionWithHttpInfo
- probeSendingConnectionDelivery() : SendingConnectionDeliveryProbeDto
- Operation probeSendingConnectionDelivery
- probeSendingConnectionDeliveryAsync() : PromiseInterface
- Operation probeSendingConnectionDeliveryAsync
- probeSendingConnectionDeliveryAsyncWithHttpInfo() : PromiseInterface
- Operation probeSendingConnectionDeliveryAsyncWithHttpInfo
- probeSendingConnectionDeliveryRequest() : Request
- Create request for operation 'probeSendingConnectionDelivery'
- probeSendingConnectionDeliveryWithHttpInfo() : array<string|int, mixed>
- Operation probeSendingConnectionDeliveryWithHttpInfo
- rotateSendingConnectionCredentials() : SendingConnectionDto
- Operation rotateSendingConnectionCredentials
- rotateSendingConnectionCredentialsAsync() : PromiseInterface
- Operation rotateSendingConnectionCredentialsAsync
- rotateSendingConnectionCredentialsAsyncWithHttpInfo() : PromiseInterface
- Operation rotateSendingConnectionCredentialsAsyncWithHttpInfo
- rotateSendingConnectionCredentialsRequest() : Request
- Create request for operation 'rotateSendingConnectionCredentials'
- rotateSendingConnectionCredentialsWithHttpInfo() : array<string|int, mixed>
- Operation rotateSendingConnectionCredentialsWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateDeliverySenderSeats() : DeliverySenderCapacityDto
- Operation updateDeliverySenderSeats
- updateDeliverySenderSeatsAsync() : PromiseInterface
- Operation updateDeliverySenderSeatsAsync
- updateDeliverySenderSeatsAsyncWithHttpInfo() : PromiseInterface
- Operation updateDeliverySenderSeatsAsyncWithHttpInfo
- updateDeliverySenderSeatsRequest() : Request
- Create request for operation 'updateDeliverySenderSeats'
- updateDeliverySenderSeatsWithHttpInfo() : array<string|int, mixed>
- Operation updateDeliverySenderSeatsWithHttpInfo
- updateSendingConnection() : SendingConnectionDto
- Operation updateSendingConnection
- updateSendingConnectionAsync() : PromiseInterface
- Operation updateSendingConnectionAsync
- updateSendingConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation updateSendingConnectionAsyncWithHttpInfo
- updateSendingConnectionRequest() : Request
- Create request for operation 'updateSendingConnection'
- updateSendingConnectionWithHttpInfo() : array<string|int, mixed>
- Operation updateSendingConnectionWithHttpInfo
- verifySendingConnection() : SendingConnectionDto
- Operation verifySendingConnection
- verifySendingConnectionAsync() : PromiseInterface
- Operation verifySendingConnectionAsync
- verifySendingConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation verifySendingConnectionAsyncWithHttpInfo
- verifySendingConnectionRequest() : Request
- Create request for operation 'verifySendingConnection'
- verifySendingConnectionWithHttpInfo() : array<string|int, mixed>
- Operation verifySendingConnectionWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createSendingConnection' => ['application/json'], 'deleteDeliverySenderSeats' => ['application/json'], 'deleteSendingConnection' => ['application/json'], 'disableSendingConnection' => ['application/json'], 'enableSendingConnection' => ['application/json'], 'getDeliverySenderCapacity' => ['application/json'], 'getSendingConnection' => ['application/json'], 'getSendingConnectionProviders' => ['application/json'], 'getSendingConnections' => ['application/json'], 'probeSendingConnectionDelivery' => ['application/json'], 'rotateSendingConnectionCredentials' => ['application/json'], 'updateDeliverySenderSeats' => ['application/json'], 'updateSendingConnection' => ['application/json'], 'verifySendingConnection' => ['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 —createSendingConnection()
Operation createSendingConnection
public
createSendingConnection(CreateSendingConnectionOptions $create_sending_connection_options[, string $contentType = self::contentTypes['createSendingConnection'][0] ]) : SendingConnectionDto
Create a sending connection
Parameters
- $create_sending_connection_options : CreateSendingConnectionOptions
-
create_sending_connection_options (required)
- $contentType : string = self::contentTypes['createSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createSendingConnection'] to see the possible values for this operation
Tags
Return values
SendingConnectionDto —createSendingConnectionAsync()
Operation createSendingConnectionAsync
public
createSendingConnectionAsync(CreateSendingConnectionOptions $create_sending_connection_options[, string $contentType = self::contentTypes['createSendingConnection'][0] ]) : PromiseInterface
Create a sending connection
Parameters
- $create_sending_connection_options : CreateSendingConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createSendingConnectionAsyncWithHttpInfo()
Operation createSendingConnectionAsyncWithHttpInfo
public
createSendingConnectionAsyncWithHttpInfo(CreateSendingConnectionOptions $create_sending_connection_options[, string $contentType = self::contentTypes['createSendingConnection'][0] ]) : PromiseInterface
Create a sending connection
Parameters
- $create_sending_connection_options : CreateSendingConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createSendingConnectionRequest()
Create request for operation 'createSendingConnection'
public
createSendingConnectionRequest(CreateSendingConnectionOptions $create_sending_connection_options[, string $contentType = self::contentTypes['createSendingConnection'][0] ]) : Request
Parameters
- $create_sending_connection_options : CreateSendingConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createSendingConnection'] to see the possible values for this operation
Tags
Return values
Request —createSendingConnectionWithHttpInfo()
Operation createSendingConnectionWithHttpInfo
public
createSendingConnectionWithHttpInfo(CreateSendingConnectionOptions $create_sending_connection_options[, string $contentType = self::contentTypes['createSendingConnection'][0] ]) : array<string|int, mixed>
Create a sending connection
Parameters
- $create_sending_connection_options : CreateSendingConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createSendingConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDto, HTTP status code, HTTP response headers (array of strings)
deleteDeliverySenderSeats()
Operation deleteDeliverySenderSeats
public
deleteDeliverySenderSeats([string $contentType = self::contentTypes['deleteDeliverySenderSeats'][0] ]) : DeliverySenderCapacityDto
Cancel purchased Delivery Sender seats
Parameters
- $contentType : string = self::contentTypes['deleteDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
DeliverySenderCapacityDto —deleteDeliverySenderSeatsAsync()
Operation deleteDeliverySenderSeatsAsync
public
deleteDeliverySenderSeatsAsync([string $contentType = self::contentTypes['deleteDeliverySenderSeats'][0] ]) : PromiseInterface
Cancel purchased Delivery Sender seats
Parameters
- $contentType : string = self::contentTypes['deleteDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDeliverySenderSeatsAsyncWithHttpInfo()
Operation deleteDeliverySenderSeatsAsyncWithHttpInfo
public
deleteDeliverySenderSeatsAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteDeliverySenderSeats'][0] ]) : PromiseInterface
Cancel purchased Delivery Sender seats
Parameters
- $contentType : string = self::contentTypes['deleteDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDeliverySenderSeatsRequest()
Create request for operation 'deleteDeliverySenderSeats'
public
deleteDeliverySenderSeatsRequest([string $contentType = self::contentTypes['deleteDeliverySenderSeats'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['deleteDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
Request —deleteDeliverySenderSeatsWithHttpInfo()
Operation deleteDeliverySenderSeatsWithHttpInfo
public
deleteDeliverySenderSeatsWithHttpInfo([string $contentType = self::contentTypes['deleteDeliverySenderSeats'][0] ]) : array<string|int, mixed>
Cancel purchased Delivery Sender seats
Parameters
- $contentType : string = self::contentTypes['deleteDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverySenderCapacityDto, HTTP status code, HTTP response headers (array of strings)
deleteSendingConnection()
Operation deleteSendingConnection
public
deleteSendingConnection(string $connection_id[, string $contentType = self::contentTypes['deleteSendingConnection'][0] ]) : void
Disconnect a sending connection
Parameters
- $connection_id : string
-
connection_id (required)
- $contentType : string = self::contentTypes['deleteSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSendingConnection'] to see the possible values for this operation
Tags
Return values
void —deleteSendingConnectionAsync()
Operation deleteSendingConnectionAsync
public
deleteSendingConnectionAsync(string $connection_id[, string $contentType = self::contentTypes['deleteSendingConnection'][0] ]) : PromiseInterface
Disconnect a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteSendingConnectionAsyncWithHttpInfo()
Operation deleteSendingConnectionAsyncWithHttpInfo
public
deleteSendingConnectionAsyncWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['deleteSendingConnection'][0] ]) : PromiseInterface
Disconnect a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteSendingConnectionRequest()
Create request for operation 'deleteSendingConnection'
public
deleteSendingConnectionRequest(string $connection_id[, string $contentType = self::contentTypes['deleteSendingConnection'][0] ]) : Request
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSendingConnection'] to see the possible values for this operation
Tags
Return values
Request —deleteSendingConnectionWithHttpInfo()
Operation deleteSendingConnectionWithHttpInfo
public
deleteSendingConnectionWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['deleteSendingConnection'][0] ]) : array<string|int, mixed>
Disconnect a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSendingConnection'] 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)
disableSendingConnection()
Operation disableSendingConnection
public
disableSendingConnection(string $connection_id[, string $contentType = self::contentTypes['disableSendingConnection'][0] ]) : SendingConnectionDto
Disable Delivery Sender capacity
Parameters
- $connection_id : string
-
connection_id (required)
- $contentType : string = self::contentTypes['disableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['disableSendingConnection'] to see the possible values for this operation
Tags
Return values
SendingConnectionDto —disableSendingConnectionAsync()
Operation disableSendingConnectionAsync
public
disableSendingConnectionAsync(string $connection_id[, string $contentType = self::contentTypes['disableSendingConnection'][0] ]) : PromiseInterface
Disable Delivery Sender capacity
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['disableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['disableSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —disableSendingConnectionAsyncWithHttpInfo()
Operation disableSendingConnectionAsyncWithHttpInfo
public
disableSendingConnectionAsyncWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['disableSendingConnection'][0] ]) : PromiseInterface
Disable Delivery Sender capacity
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['disableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['disableSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —disableSendingConnectionRequest()
Create request for operation 'disableSendingConnection'
public
disableSendingConnectionRequest(string $connection_id[, string $contentType = self::contentTypes['disableSendingConnection'][0] ]) : Request
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['disableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['disableSendingConnection'] to see the possible values for this operation
Tags
Return values
Request —disableSendingConnectionWithHttpInfo()
Operation disableSendingConnectionWithHttpInfo
public
disableSendingConnectionWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['disableSendingConnection'][0] ]) : array<string|int, mixed>
Disable Delivery Sender capacity
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['disableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['disableSendingConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDto, HTTP status code, HTTP response headers (array of strings)
enableSendingConnection()
Operation enableSendingConnection
public
enableSendingConnection(string $connection_id[, string $contentType = self::contentTypes['enableSendingConnection'][0] ]) : SendingConnectionDto
Enable a verified Delivery Sender
Parameters
- $connection_id : string
-
connection_id (required)
- $contentType : string = self::contentTypes['enableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['enableSendingConnection'] to see the possible values for this operation
Tags
Return values
SendingConnectionDto —enableSendingConnectionAsync()
Operation enableSendingConnectionAsync
public
enableSendingConnectionAsync(string $connection_id[, string $contentType = self::contentTypes['enableSendingConnection'][0] ]) : PromiseInterface
Enable a verified Delivery Sender
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['enableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['enableSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —enableSendingConnectionAsyncWithHttpInfo()
Operation enableSendingConnectionAsyncWithHttpInfo
public
enableSendingConnectionAsyncWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['enableSendingConnection'][0] ]) : PromiseInterface
Enable a verified Delivery Sender
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['enableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['enableSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —enableSendingConnectionRequest()
Create request for operation 'enableSendingConnection'
public
enableSendingConnectionRequest(string $connection_id[, string $contentType = self::contentTypes['enableSendingConnection'][0] ]) : Request
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['enableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['enableSendingConnection'] to see the possible values for this operation
Tags
Return values
Request —enableSendingConnectionWithHttpInfo()
Operation enableSendingConnectionWithHttpInfo
public
enableSendingConnectionWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['enableSendingConnection'][0] ]) : array<string|int, mixed>
Enable a verified Delivery Sender
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['enableSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['enableSendingConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDto, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getDeliverySenderCapacity()
Operation getDeliverySenderCapacity
public
getDeliverySenderCapacity([string $contentType = self::contentTypes['getDeliverySenderCapacity'][0] ]) : DeliverySenderCapacityDto
Get shared Delivery Sender capacity
Parameters
- $contentType : string = self::contentTypes['getDeliverySenderCapacity'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverySenderCapacity'] to see the possible values for this operation
Tags
Return values
DeliverySenderCapacityDto —getDeliverySenderCapacityAsync()
Operation getDeliverySenderCapacityAsync
public
getDeliverySenderCapacityAsync([string $contentType = self::contentTypes['getDeliverySenderCapacity'][0] ]) : PromiseInterface
Get shared Delivery Sender capacity
Parameters
- $contentType : string = self::contentTypes['getDeliverySenderCapacity'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverySenderCapacity'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverySenderCapacityAsyncWithHttpInfo()
Operation getDeliverySenderCapacityAsyncWithHttpInfo
public
getDeliverySenderCapacityAsyncWithHttpInfo([string $contentType = self::contentTypes['getDeliverySenderCapacity'][0] ]) : PromiseInterface
Get shared Delivery Sender capacity
Parameters
- $contentType : string = self::contentTypes['getDeliverySenderCapacity'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverySenderCapacity'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverySenderCapacityRequest()
Create request for operation 'getDeliverySenderCapacity'
public
getDeliverySenderCapacityRequest([string $contentType = self::contentTypes['getDeliverySenderCapacity'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getDeliverySenderCapacity'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverySenderCapacity'] to see the possible values for this operation
Tags
Return values
Request —getDeliverySenderCapacityWithHttpInfo()
Operation getDeliverySenderCapacityWithHttpInfo
public
getDeliverySenderCapacityWithHttpInfo([string $contentType = self::contentTypes['getDeliverySenderCapacity'][0] ]) : array<string|int, mixed>
Get shared Delivery Sender capacity
Parameters
- $contentType : string = self::contentTypes['getDeliverySenderCapacity'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverySenderCapacity'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverySenderCapacityDto, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getSendingConnection()
Operation getSendingConnection
public
getSendingConnection(string $connection_id[, string $contentType = self::contentTypes['getSendingConnection'][0] ]) : SendingConnectionDto
Get a sending connection
Parameters
- $connection_id : string
-
connection_id (required)
- $contentType : string = self::contentTypes['getSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnection'] to see the possible values for this operation
Tags
Return values
SendingConnectionDto —getSendingConnectionAsync()
Operation getSendingConnectionAsync
public
getSendingConnectionAsync(string $connection_id[, string $contentType = self::contentTypes['getSendingConnection'][0] ]) : PromiseInterface
Get a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['getSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSendingConnectionAsyncWithHttpInfo()
Operation getSendingConnectionAsyncWithHttpInfo
public
getSendingConnectionAsyncWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['getSendingConnection'][0] ]) : PromiseInterface
Get a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['getSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSendingConnectionProviders()
Operation getSendingConnectionProviders
public
getSendingConnectionProviders([string $contentType = self::contentTypes['getSendingConnectionProviders'][0] ]) : array<string|int, SendingConnectionProviderDto>
List sending connection providers
Parameters
- $contentType : string = self::contentTypes['getSendingConnectionProviders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnectionProviders'] to see the possible values for this operation
Tags
Return values
array<string|int, SendingConnectionProviderDto> —getSendingConnectionProvidersAsync()
Operation getSendingConnectionProvidersAsync
public
getSendingConnectionProvidersAsync([string $contentType = self::contentTypes['getSendingConnectionProviders'][0] ]) : PromiseInterface
List sending connection providers
Parameters
- $contentType : string = self::contentTypes['getSendingConnectionProviders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnectionProviders'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSendingConnectionProvidersAsyncWithHttpInfo()
Operation getSendingConnectionProvidersAsyncWithHttpInfo
public
getSendingConnectionProvidersAsyncWithHttpInfo([string $contentType = self::contentTypes['getSendingConnectionProviders'][0] ]) : PromiseInterface
List sending connection providers
Parameters
- $contentType : string = self::contentTypes['getSendingConnectionProviders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnectionProviders'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSendingConnectionProvidersRequest()
Create request for operation 'getSendingConnectionProviders'
public
getSendingConnectionProvidersRequest([string $contentType = self::contentTypes['getSendingConnectionProviders'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getSendingConnectionProviders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnectionProviders'] to see the possible values for this operation
Tags
Return values
Request —getSendingConnectionProvidersWithHttpInfo()
Operation getSendingConnectionProvidersWithHttpInfo
public
getSendingConnectionProvidersWithHttpInfo([string $contentType = self::contentTypes['getSendingConnectionProviders'][0] ]) : array<string|int, mixed>
List sending connection providers
Parameters
- $contentType : string = self::contentTypes['getSendingConnectionProviders'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnectionProviders'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionProviderDto[], HTTP status code, HTTP response headers (array of strings)
getSendingConnectionRequest()
Create request for operation 'getSendingConnection'
public
getSendingConnectionRequest(string $connection_id[, string $contentType = self::contentTypes['getSendingConnection'][0] ]) : Request
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['getSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnection'] to see the possible values for this operation
Tags
Return values
Request —getSendingConnections()
Operation getSendingConnections
public
getSendingConnections([string $contentType = self::contentTypes['getSendingConnections'][0] ]) : array<string|int, SendingConnectionDto>
List sending connections
Parameters
- $contentType : string = self::contentTypes['getSendingConnections'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnections'] to see the possible values for this operation
Tags
Return values
array<string|int, SendingConnectionDto> —getSendingConnectionsAsync()
Operation getSendingConnectionsAsync
public
getSendingConnectionsAsync([string $contentType = self::contentTypes['getSendingConnections'][0] ]) : PromiseInterface
List sending connections
Parameters
- $contentType : string = self::contentTypes['getSendingConnections'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnections'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSendingConnectionsAsyncWithHttpInfo()
Operation getSendingConnectionsAsyncWithHttpInfo
public
getSendingConnectionsAsyncWithHttpInfo([string $contentType = self::contentTypes['getSendingConnections'][0] ]) : PromiseInterface
List sending connections
Parameters
- $contentType : string = self::contentTypes['getSendingConnections'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnections'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSendingConnectionsRequest()
Create request for operation 'getSendingConnections'
public
getSendingConnectionsRequest([string $contentType = self::contentTypes['getSendingConnections'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getSendingConnections'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnections'] to see the possible values for this operation
Tags
Return values
Request —getSendingConnectionsWithHttpInfo()
Operation getSendingConnectionsWithHttpInfo
public
getSendingConnectionsWithHttpInfo([string $contentType = self::contentTypes['getSendingConnections'][0] ]) : array<string|int, mixed>
List sending connections
Parameters
- $contentType : string = self::contentTypes['getSendingConnections'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnections'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDto[], HTTP status code, HTTP response headers (array of strings)
getSendingConnectionWithHttpInfo()
Operation getSendingConnectionWithHttpInfo
public
getSendingConnectionWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['getSendingConnection'][0] ]) : array<string|int, mixed>
Get a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['getSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSendingConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDto, HTTP status code, HTTP response headers (array of strings)
probeSendingConnectionDelivery()
Operation probeSendingConnectionDelivery
public
probeSendingConnectionDelivery(string $connection_id[, string $contentType = self::contentTypes['probeSendingConnectionDelivery'][0] ]) : SendingConnectionDeliveryProbeDto
Send an unbilled delivery test to a temporary MailSlurp inbox
Parameters
- $connection_id : string
-
connection_id (required)
- $contentType : string = self::contentTypes['probeSendingConnectionDelivery'][0]
-
The value for the Content-Type header. Check self::contentTypes['probeSendingConnectionDelivery'] to see the possible values for this operation
Tags
Return values
SendingConnectionDeliveryProbeDto —probeSendingConnectionDeliveryAsync()
Operation probeSendingConnectionDeliveryAsync
public
probeSendingConnectionDeliveryAsync(string $connection_id[, string $contentType = self::contentTypes['probeSendingConnectionDelivery'][0] ]) : PromiseInterface
Send an unbilled delivery test to a temporary MailSlurp inbox
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['probeSendingConnectionDelivery'][0]
-
The value for the Content-Type header. Check self::contentTypes['probeSendingConnectionDelivery'] to see the possible values for this operation
Tags
Return values
PromiseInterface —probeSendingConnectionDeliveryAsyncWithHttpInfo()
Operation probeSendingConnectionDeliveryAsyncWithHttpInfo
public
probeSendingConnectionDeliveryAsyncWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['probeSendingConnectionDelivery'][0] ]) : PromiseInterface
Send an unbilled delivery test to a temporary MailSlurp inbox
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['probeSendingConnectionDelivery'][0]
-
The value for the Content-Type header. Check self::contentTypes['probeSendingConnectionDelivery'] to see the possible values for this operation
Tags
Return values
PromiseInterface —probeSendingConnectionDeliveryRequest()
Create request for operation 'probeSendingConnectionDelivery'
public
probeSendingConnectionDeliveryRequest(string $connection_id[, string $contentType = self::contentTypes['probeSendingConnectionDelivery'][0] ]) : Request
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['probeSendingConnectionDelivery'][0]
-
The value for the Content-Type header. Check self::contentTypes['probeSendingConnectionDelivery'] to see the possible values for this operation
Tags
Return values
Request —probeSendingConnectionDeliveryWithHttpInfo()
Operation probeSendingConnectionDeliveryWithHttpInfo
public
probeSendingConnectionDeliveryWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['probeSendingConnectionDelivery'][0] ]) : array<string|int, mixed>
Send an unbilled delivery test to a temporary MailSlurp inbox
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['probeSendingConnectionDelivery'][0]
-
The value for the Content-Type header. Check self::contentTypes['probeSendingConnectionDelivery'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDeliveryProbeDto, HTTP status code, HTTP response headers (array of strings)
rotateSendingConnectionCredentials()
Operation rotateSendingConnectionCredentials
public
rotateSendingConnectionCredentials(string $connection_id, RotateSendingConnectionCredentialsOptions $rotate_sending_connection_credentials_options[, string $contentType = self::contentTypes['rotateSendingConnectionCredentials'][0] ]) : SendingConnectionDto
Rotate sending connection credentials
Parameters
- $connection_id : string
-
connection_id (required)
- $rotate_sending_connection_credentials_options : RotateSendingConnectionCredentialsOptions
-
rotate_sending_connection_credentials_options (required)
- $contentType : string = self::contentTypes['rotateSendingConnectionCredentials'][0]
-
The value for the Content-Type header. Check self::contentTypes['rotateSendingConnectionCredentials'] to see the possible values for this operation
Tags
Return values
SendingConnectionDto —rotateSendingConnectionCredentialsAsync()
Operation rotateSendingConnectionCredentialsAsync
public
rotateSendingConnectionCredentialsAsync(string $connection_id, RotateSendingConnectionCredentialsOptions $rotate_sending_connection_credentials_options[, string $contentType = self::contentTypes['rotateSendingConnectionCredentials'][0] ]) : PromiseInterface
Rotate sending connection credentials
Parameters
- $connection_id : string
-
(required)
- $rotate_sending_connection_credentials_options : RotateSendingConnectionCredentialsOptions
-
(required)
- $contentType : string = self::contentTypes['rotateSendingConnectionCredentials'][0]
-
The value for the Content-Type header. Check self::contentTypes['rotateSendingConnectionCredentials'] to see the possible values for this operation
Tags
Return values
PromiseInterface —rotateSendingConnectionCredentialsAsyncWithHttpInfo()
Operation rotateSendingConnectionCredentialsAsyncWithHttpInfo
public
rotateSendingConnectionCredentialsAsyncWithHttpInfo(string $connection_id, RotateSendingConnectionCredentialsOptions $rotate_sending_connection_credentials_options[, string $contentType = self::contentTypes['rotateSendingConnectionCredentials'][0] ]) : PromiseInterface
Rotate sending connection credentials
Parameters
- $connection_id : string
-
(required)
- $rotate_sending_connection_credentials_options : RotateSendingConnectionCredentialsOptions
-
(required)
- $contentType : string = self::contentTypes['rotateSendingConnectionCredentials'][0]
-
The value for the Content-Type header. Check self::contentTypes['rotateSendingConnectionCredentials'] to see the possible values for this operation
Tags
Return values
PromiseInterface —rotateSendingConnectionCredentialsRequest()
Create request for operation 'rotateSendingConnectionCredentials'
public
rotateSendingConnectionCredentialsRequest(string $connection_id, RotateSendingConnectionCredentialsOptions $rotate_sending_connection_credentials_options[, string $contentType = self::contentTypes['rotateSendingConnectionCredentials'][0] ]) : Request
Parameters
- $connection_id : string
-
(required)
- $rotate_sending_connection_credentials_options : RotateSendingConnectionCredentialsOptions
-
(required)
- $contentType : string = self::contentTypes['rotateSendingConnectionCredentials'][0]
-
The value for the Content-Type header. Check self::contentTypes['rotateSendingConnectionCredentials'] to see the possible values for this operation
Tags
Return values
Request —rotateSendingConnectionCredentialsWithHttpInfo()
Operation rotateSendingConnectionCredentialsWithHttpInfo
public
rotateSendingConnectionCredentialsWithHttpInfo(string $connection_id, RotateSendingConnectionCredentialsOptions $rotate_sending_connection_credentials_options[, string $contentType = self::contentTypes['rotateSendingConnectionCredentials'][0] ]) : array<string|int, mixed>
Rotate sending connection credentials
Parameters
- $connection_id : string
-
(required)
- $rotate_sending_connection_credentials_options : RotateSendingConnectionCredentialsOptions
-
(required)
- $contentType : string = self::contentTypes['rotateSendingConnectionCredentials'][0]
-
The value for the Content-Type header. Check self::contentTypes['rotateSendingConnectionCredentials'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDto, 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 —updateDeliverySenderSeats()
Operation updateDeliverySenderSeats
public
updateDeliverySenderSeats(UpdateDeliverySenderSeatsOptions $update_delivery_sender_seats_options[, string $contentType = self::contentTypes['updateDeliverySenderSeats'][0] ]) : DeliverySenderCapacityDto
Update purchased Delivery Sender seats
Parameters
- $update_delivery_sender_seats_options : UpdateDeliverySenderSeatsOptions
-
update_delivery_sender_seats_options (required)
- $contentType : string = self::contentTypes['updateDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
DeliverySenderCapacityDto —updateDeliverySenderSeatsAsync()
Operation updateDeliverySenderSeatsAsync
public
updateDeliverySenderSeatsAsync(UpdateDeliverySenderSeatsOptions $update_delivery_sender_seats_options[, string $contentType = self::contentTypes['updateDeliverySenderSeats'][0] ]) : PromiseInterface
Update purchased Delivery Sender seats
Parameters
- $update_delivery_sender_seats_options : UpdateDeliverySenderSeatsOptions
-
(required)
- $contentType : string = self::contentTypes['updateDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateDeliverySenderSeatsAsyncWithHttpInfo()
Operation updateDeliverySenderSeatsAsyncWithHttpInfo
public
updateDeliverySenderSeatsAsyncWithHttpInfo(UpdateDeliverySenderSeatsOptions $update_delivery_sender_seats_options[, string $contentType = self::contentTypes['updateDeliverySenderSeats'][0] ]) : PromiseInterface
Update purchased Delivery Sender seats
Parameters
- $update_delivery_sender_seats_options : UpdateDeliverySenderSeatsOptions
-
(required)
- $contentType : string = self::contentTypes['updateDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateDeliverySenderSeatsRequest()
Create request for operation 'updateDeliverySenderSeats'
public
updateDeliverySenderSeatsRequest(UpdateDeliverySenderSeatsOptions $update_delivery_sender_seats_options[, string $contentType = self::contentTypes['updateDeliverySenderSeats'][0] ]) : Request
Parameters
- $update_delivery_sender_seats_options : UpdateDeliverySenderSeatsOptions
-
(required)
- $contentType : string = self::contentTypes['updateDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
Request —updateDeliverySenderSeatsWithHttpInfo()
Operation updateDeliverySenderSeatsWithHttpInfo
public
updateDeliverySenderSeatsWithHttpInfo(UpdateDeliverySenderSeatsOptions $update_delivery_sender_seats_options[, string $contentType = self::contentTypes['updateDeliverySenderSeats'][0] ]) : array<string|int, mixed>
Update purchased Delivery Sender seats
Parameters
- $update_delivery_sender_seats_options : UpdateDeliverySenderSeatsOptions
-
(required)
- $contentType : string = self::contentTypes['updateDeliverySenderSeats'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverySenderSeats'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverySenderCapacityDto, HTTP status code, HTTP response headers (array of strings)
updateSendingConnection()
Operation updateSendingConnection
public
updateSendingConnection(string $connection_id, UpdateSendingConnectionOptions $update_sending_connection_options[, string $contentType = self::contentTypes['updateSendingConnection'][0] ]) : SendingConnectionDto
Update a sending connection
Parameters
- $connection_id : string
-
connection_id (required)
- $update_sending_connection_options : UpdateSendingConnectionOptions
-
update_sending_connection_options (required)
- $contentType : string = self::contentTypes['updateSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateSendingConnection'] to see the possible values for this operation
Tags
Return values
SendingConnectionDto —updateSendingConnectionAsync()
Operation updateSendingConnectionAsync
public
updateSendingConnectionAsync(string $connection_id, UpdateSendingConnectionOptions $update_sending_connection_options[, string $contentType = self::contentTypes['updateSendingConnection'][0] ]) : PromiseInterface
Update a sending connection
Parameters
- $connection_id : string
-
(required)
- $update_sending_connection_options : UpdateSendingConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['updateSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateSendingConnectionAsyncWithHttpInfo()
Operation updateSendingConnectionAsyncWithHttpInfo
public
updateSendingConnectionAsyncWithHttpInfo(string $connection_id, UpdateSendingConnectionOptions $update_sending_connection_options[, string $contentType = self::contentTypes['updateSendingConnection'][0] ]) : PromiseInterface
Update a sending connection
Parameters
- $connection_id : string
-
(required)
- $update_sending_connection_options : UpdateSendingConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['updateSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateSendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateSendingConnectionRequest()
Create request for operation 'updateSendingConnection'
public
updateSendingConnectionRequest(string $connection_id, UpdateSendingConnectionOptions $update_sending_connection_options[, string $contentType = self::contentTypes['updateSendingConnection'][0] ]) : Request
Parameters
- $connection_id : string
-
(required)
- $update_sending_connection_options : UpdateSendingConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['updateSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateSendingConnection'] to see the possible values for this operation
Tags
Return values
Request —updateSendingConnectionWithHttpInfo()
Operation updateSendingConnectionWithHttpInfo
public
updateSendingConnectionWithHttpInfo(string $connection_id, UpdateSendingConnectionOptions $update_sending_connection_options[, string $contentType = self::contentTypes['updateSendingConnection'][0] ]) : array<string|int, mixed>
Update a sending connection
Parameters
- $connection_id : string
-
(required)
- $update_sending_connection_options : UpdateSendingConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['updateSendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateSendingConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDto, HTTP status code, HTTP response headers (array of strings)
verifySendingConnection()
Operation verifySendingConnection
public
verifySendingConnection(string $connection_id[, string $contentType = self::contentTypes['verifySendingConnection'][0] ]) : SendingConnectionDto
Verify a sending connection
Parameters
- $connection_id : string
-
connection_id (required)
- $contentType : string = self::contentTypes['verifySendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifySendingConnection'] to see the possible values for this operation
Tags
Return values
SendingConnectionDto —verifySendingConnectionAsync()
Operation verifySendingConnectionAsync
public
verifySendingConnectionAsync(string $connection_id[, string $contentType = self::contentTypes['verifySendingConnection'][0] ]) : PromiseInterface
Verify a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['verifySendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifySendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —verifySendingConnectionAsyncWithHttpInfo()
Operation verifySendingConnectionAsyncWithHttpInfo
public
verifySendingConnectionAsyncWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['verifySendingConnection'][0] ]) : PromiseInterface
Verify a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['verifySendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifySendingConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —verifySendingConnectionRequest()
Create request for operation 'verifySendingConnection'
public
verifySendingConnectionRequest(string $connection_id[, string $contentType = self::contentTypes['verifySendingConnection'][0] ]) : Request
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['verifySendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifySendingConnection'] to see the possible values for this operation
Tags
Return values
Request —verifySendingConnectionWithHttpInfo()
Operation verifySendingConnectionWithHttpInfo
public
verifySendingConnectionWithHttpInfo(string $connection_id[, string $contentType = self::contentTypes['verifySendingConnection'][0] ]) : array<string|int, mixed>
Verify a sending connection
Parameters
- $connection_id : string
-
(required)
- $contentType : string = self::contentTypes['verifySendingConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifySendingConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SendingConnectionDto, 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