ConnectorControllerApi
in package
ConnectorControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createConnector' => ['application/json'], 'createConnectorImapConnection' => ['application/json'], 'createConnectorSmtpConnection' => ['application/json'], 'deleteAllConnector' => ['application/json'], 'deleteConnector' => ['application/json'], 'deleteConnectorImapConnection' => ['application/json'], 'deleteConnectorSmtpConnection' => ['application/json'], 'getAllConnectorSyncEvents' => ['application/json'], 'getConnector' => ['application/json'], 'getConnectorSyncEvent' => ['application/json'], 'getConnectorSyncEvents' => ['application/json'], 'getConnectors' => ['application/json'], 'syncConnector' => ['application/json'], 'updateConnector' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createConnector() : ConnectorDto
- Operation createConnector
- createConnectorAsync() : PromiseInterface
- Operation createConnectorAsync
- createConnectorAsyncWithHttpInfo() : PromiseInterface
- Operation createConnectorAsyncWithHttpInfo
- createConnectorImapConnection() : ConnectorImapConnectionDto
- Operation createConnectorImapConnection
- createConnectorImapConnectionAsync() : PromiseInterface
- Operation createConnectorImapConnectionAsync
- createConnectorImapConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation createConnectorImapConnectionAsyncWithHttpInfo
- createConnectorImapConnectionRequest() : Request
- Create request for operation 'createConnectorImapConnection'
- createConnectorImapConnectionWithHttpInfo() : array<string|int, mixed>
- Operation createConnectorImapConnectionWithHttpInfo
- createConnectorRequest() : Request
- Create request for operation 'createConnector'
- createConnectorSmtpConnection() : ConnectorSmtpConnectionDto
- Operation createConnectorSmtpConnection
- createConnectorSmtpConnectionAsync() : PromiseInterface
- Operation createConnectorSmtpConnectionAsync
- createConnectorSmtpConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation createConnectorSmtpConnectionAsyncWithHttpInfo
- createConnectorSmtpConnectionRequest() : Request
- Create request for operation 'createConnectorSmtpConnection'
- createConnectorSmtpConnectionWithHttpInfo() : array<string|int, mixed>
- Operation createConnectorSmtpConnectionWithHttpInfo
- createConnectorWithHttpInfo() : array<string|int, mixed>
- Operation createConnectorWithHttpInfo
- deleteAllConnector() : void
- Operation deleteAllConnector
- deleteAllConnectorAsync() : PromiseInterface
- Operation deleteAllConnectorAsync
- deleteAllConnectorAsyncWithHttpInfo() : PromiseInterface
- Operation deleteAllConnectorAsyncWithHttpInfo
- deleteAllConnectorRequest() : Request
- Create request for operation 'deleteAllConnector'
- deleteAllConnectorWithHttpInfo() : array<string|int, mixed>
- Operation deleteAllConnectorWithHttpInfo
- deleteConnector() : void
- Operation deleteConnector
- deleteConnectorAsync() : PromiseInterface
- Operation deleteConnectorAsync
- deleteConnectorAsyncWithHttpInfo() : PromiseInterface
- Operation deleteConnectorAsyncWithHttpInfo
- deleteConnectorImapConnection() : void
- Operation deleteConnectorImapConnection
- deleteConnectorImapConnectionAsync() : PromiseInterface
- Operation deleteConnectorImapConnectionAsync
- deleteConnectorImapConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation deleteConnectorImapConnectionAsyncWithHttpInfo
- deleteConnectorImapConnectionRequest() : Request
- Create request for operation 'deleteConnectorImapConnection'
- deleteConnectorImapConnectionWithHttpInfo() : array<string|int, mixed>
- Operation deleteConnectorImapConnectionWithHttpInfo
- deleteConnectorRequest() : Request
- Create request for operation 'deleteConnector'
- deleteConnectorSmtpConnection() : void
- Operation deleteConnectorSmtpConnection
- deleteConnectorSmtpConnectionAsync() : PromiseInterface
- Operation deleteConnectorSmtpConnectionAsync
- deleteConnectorSmtpConnectionAsyncWithHttpInfo() : PromiseInterface
- Operation deleteConnectorSmtpConnectionAsyncWithHttpInfo
- deleteConnectorSmtpConnectionRequest() : Request
- Create request for operation 'deleteConnectorSmtpConnection'
- deleteConnectorSmtpConnectionWithHttpInfo() : array<string|int, mixed>
- Operation deleteConnectorSmtpConnectionWithHttpInfo
- deleteConnectorWithHttpInfo() : array<string|int, mixed>
- Operation deleteConnectorWithHttpInfo
- getAllConnectorSyncEvents() : PageConnectorSyncEvents
- Operation getAllConnectorSyncEvents
- getAllConnectorSyncEventsAsync() : PromiseInterface
- Operation getAllConnectorSyncEventsAsync
- getAllConnectorSyncEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getAllConnectorSyncEventsAsyncWithHttpInfo
- getAllConnectorSyncEventsRequest() : Request
- Create request for operation 'getAllConnectorSyncEvents'
- getAllConnectorSyncEventsWithHttpInfo() : array<string|int, mixed>
- Operation getAllConnectorSyncEventsWithHttpInfo
- getConfig() : Configuration
- getConnector() : ConnectorDto
- Operation getConnector
- getConnectorAsync() : PromiseInterface
- Operation getConnectorAsync
- getConnectorAsyncWithHttpInfo() : PromiseInterface
- Operation getConnectorAsyncWithHttpInfo
- getConnectorRequest() : Request
- Create request for operation 'getConnector'
- getConnectors() : PageConnector
- Operation getConnectors
- getConnectorsAsync() : PromiseInterface
- Operation getConnectorsAsync
- getConnectorsAsyncWithHttpInfo() : PromiseInterface
- Operation getConnectorsAsyncWithHttpInfo
- getConnectorsRequest() : Request
- Create request for operation 'getConnectors'
- getConnectorsWithHttpInfo() : array<string|int, mixed>
- Operation getConnectorsWithHttpInfo
- getConnectorSyncEvent() : ConnectorSyncEventDto
- Operation getConnectorSyncEvent
- getConnectorSyncEventAsync() : PromiseInterface
- Operation getConnectorSyncEventAsync
- getConnectorSyncEventAsyncWithHttpInfo() : PromiseInterface
- Operation getConnectorSyncEventAsyncWithHttpInfo
- getConnectorSyncEventRequest() : Request
- Create request for operation 'getConnectorSyncEvent'
- getConnectorSyncEvents() : PageConnectorSyncEvents
- Operation getConnectorSyncEvents
- getConnectorSyncEventsAsync() : PromiseInterface
- Operation getConnectorSyncEventsAsync
- getConnectorSyncEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getConnectorSyncEventsAsyncWithHttpInfo
- getConnectorSyncEventsRequest() : Request
- Create request for operation 'getConnectorSyncEvents'
- getConnectorSyncEventsWithHttpInfo() : array<string|int, mixed>
- Operation getConnectorSyncEventsWithHttpInfo
- getConnectorSyncEventWithHttpInfo() : array<string|int, mixed>
- Operation getConnectorSyncEventWithHttpInfo
- getConnectorWithHttpInfo() : array<string|int, mixed>
- Operation getConnectorWithHttpInfo
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- syncConnector() : ConnectorSyncRequestResult
- Operation syncConnector
- syncConnectorAsync() : PromiseInterface
- Operation syncConnectorAsync
- syncConnectorAsyncWithHttpInfo() : PromiseInterface
- Operation syncConnectorAsyncWithHttpInfo
- syncConnectorRequest() : Request
- Create request for operation 'syncConnector'
- syncConnectorWithHttpInfo() : array<string|int, mixed>
- Operation syncConnectorWithHttpInfo
- updateConnector() : ConnectorDto
- Operation updateConnector
- updateConnectorAsync() : PromiseInterface
- Operation updateConnectorAsync
- updateConnectorAsyncWithHttpInfo() : PromiseInterface
- Operation updateConnectorAsyncWithHttpInfo
- updateConnectorRequest() : Request
- Create request for operation 'updateConnector'
- updateConnectorWithHttpInfo() : array<string|int, mixed>
- Operation updateConnectorWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createConnector' => ['application/json'], 'createConnectorImapConnection' => ['application/json'], 'createConnectorSmtpConnection' => ['application/json'], 'deleteAllConnector' => ['application/json'], 'deleteConnector' => ['application/json'], 'deleteConnectorImapConnection' => ['application/json'], 'deleteConnectorSmtpConnection' => ['application/json'], 'getAllConnectorSyncEvents' => ['application/json'], 'getConnector' => ['application/json'], 'getConnectorSyncEvent' => ['application/json'], 'getConnectorSyncEvents' => ['application/json'], 'getConnectors' => ['application/json'], 'syncConnector' => ['application/json'], 'updateConnector' => ['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 —createConnector()
Operation createConnector
public
createConnector(CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['createConnector'][0] ]) : ConnectorDto
Create an inbox connector
Parameters
- $create_connector_options : CreateConnectorOptions
-
create_connector_options (required)
- $contentType : string = self::contentTypes['createConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnector'] to see the possible values for this operation
Tags
Return values
ConnectorDto —createConnectorAsync()
Operation createConnectorAsync
public
createConnectorAsync(CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['createConnector'][0] ]) : PromiseInterface
Create an inbox connector
Parameters
- $create_connector_options : CreateConnectorOptions
-
(required)
- $contentType : string = self::contentTypes['createConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createConnectorAsyncWithHttpInfo()
Operation createConnectorAsyncWithHttpInfo
public
createConnectorAsyncWithHttpInfo(CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['createConnector'][0] ]) : PromiseInterface
Create an inbox connector
Parameters
- $create_connector_options : CreateConnectorOptions
-
(required)
- $contentType : string = self::contentTypes['createConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createConnectorImapConnection()
Operation createConnectorImapConnection
public
createConnectorImapConnection(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['createConnectorImapConnection'][0] ]) : ConnectorImapConnectionDto
Create an inbox connector IMAP connection
Parameters
- $id : string
-
id (required)
- $create_connector_imap_connection_options : CreateConnectorImapConnectionOptions
-
create_connector_imap_connection_options (required)
- $contentType : string = self::contentTypes['createConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
ConnectorImapConnectionDto —createConnectorImapConnectionAsync()
Operation createConnectorImapConnectionAsync
public
createConnectorImapConnectionAsync(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['createConnectorImapConnection'][0] ]) : PromiseInterface
Create an inbox connector IMAP connection
Parameters
- $id : string
-
(required)
- $create_connector_imap_connection_options : CreateConnectorImapConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createConnectorImapConnectionAsyncWithHttpInfo()
Operation createConnectorImapConnectionAsyncWithHttpInfo
public
createConnectorImapConnectionAsyncWithHttpInfo(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['createConnectorImapConnection'][0] ]) : PromiseInterface
Create an inbox connector IMAP connection
Parameters
- $id : string
-
(required)
- $create_connector_imap_connection_options : CreateConnectorImapConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createConnectorImapConnectionRequest()
Create request for operation 'createConnectorImapConnection'
public
createConnectorImapConnectionRequest(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['createConnectorImapConnection'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $create_connector_imap_connection_options : CreateConnectorImapConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
Request —createConnectorImapConnectionWithHttpInfo()
Operation createConnectorImapConnectionWithHttpInfo
public
createConnectorImapConnectionWithHttpInfo(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['createConnectorImapConnection'][0] ]) : array<string|int, mixed>
Create an inbox connector IMAP connection
Parameters
- $id : string
-
(required)
- $create_connector_imap_connection_options : CreateConnectorImapConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ConnectorImapConnectionDto, HTTP status code, HTTP response headers (array of strings)
createConnectorRequest()
Create request for operation 'createConnector'
public
createConnectorRequest(CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['createConnector'][0] ]) : Request
Parameters
- $create_connector_options : CreateConnectorOptions
-
(required)
- $contentType : string = self::contentTypes['createConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnector'] to see the possible values for this operation
Tags
Return values
Request —createConnectorSmtpConnection()
Operation createConnectorSmtpConnection
public
createConnectorSmtpConnection(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['createConnectorSmtpConnection'][0] ]) : ConnectorSmtpConnectionDto
Create an inbox connector SMTP connection
Parameters
- $id : string
-
id (required)
- $create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions
-
create_connector_smtp_connection_options (required)
- $contentType : string = self::contentTypes['createConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
ConnectorSmtpConnectionDto —createConnectorSmtpConnectionAsync()
Operation createConnectorSmtpConnectionAsync
public
createConnectorSmtpConnectionAsync(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['createConnectorSmtpConnection'][0] ]) : PromiseInterface
Create an inbox connector SMTP connection
Parameters
- $id : string
-
(required)
- $create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createConnectorSmtpConnectionAsyncWithHttpInfo()
Operation createConnectorSmtpConnectionAsyncWithHttpInfo
public
createConnectorSmtpConnectionAsyncWithHttpInfo(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['createConnectorSmtpConnection'][0] ]) : PromiseInterface
Create an inbox connector SMTP connection
Parameters
- $id : string
-
(required)
- $create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createConnectorSmtpConnectionRequest()
Create request for operation 'createConnectorSmtpConnection'
public
createConnectorSmtpConnectionRequest(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['createConnectorSmtpConnection'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
Request —createConnectorSmtpConnectionWithHttpInfo()
Operation createConnectorSmtpConnectionWithHttpInfo
public
createConnectorSmtpConnectionWithHttpInfo(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['createConnectorSmtpConnection'][0] ]) : array<string|int, mixed>
Create an inbox connector SMTP connection
Parameters
- $id : string
-
(required)
- $create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions
-
(required)
- $contentType : string = self::contentTypes['createConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ConnectorSmtpConnectionDto, HTTP status code, HTTP response headers (array of strings)
createConnectorWithHttpInfo()
Operation createConnectorWithHttpInfo
public
createConnectorWithHttpInfo(CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['createConnector'][0] ]) : array<string|int, mixed>
Create an inbox connector
Parameters
- $create_connector_options : CreateConnectorOptions
-
(required)
- $contentType : string = self::contentTypes['createConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['createConnector'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ConnectorDto, HTTP status code, HTTP response headers (array of strings)
deleteAllConnector()
Operation deleteAllConnector
public
deleteAllConnector([string $contentType = self::contentTypes['deleteAllConnector'][0] ]) : void
Delete all inbox connectors
Parameters
- $contentType : string = self::contentTypes['deleteAllConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllConnector'] to see the possible values for this operation
Tags
Return values
void —deleteAllConnectorAsync()
Operation deleteAllConnectorAsync
public
deleteAllConnectorAsync([string $contentType = self::contentTypes['deleteAllConnector'][0] ]) : PromiseInterface
Delete all inbox connectors
Parameters
- $contentType : string = self::contentTypes['deleteAllConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllConnectorAsyncWithHttpInfo()
Operation deleteAllConnectorAsyncWithHttpInfo
public
deleteAllConnectorAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteAllConnector'][0] ]) : PromiseInterface
Delete all inbox connectors
Parameters
- $contentType : string = self::contentTypes['deleteAllConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllConnectorRequest()
Create request for operation 'deleteAllConnector'
public
deleteAllConnectorRequest([string $contentType = self::contentTypes['deleteAllConnector'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['deleteAllConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllConnector'] to see the possible values for this operation
Tags
Return values
Request —deleteAllConnectorWithHttpInfo()
Operation deleteAllConnectorWithHttpInfo
public
deleteAllConnectorWithHttpInfo([string $contentType = self::contentTypes['deleteAllConnector'][0] ]) : array<string|int, mixed>
Delete all inbox connectors
Parameters
- $contentType : string = self::contentTypes['deleteAllConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllConnector'] 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)
deleteConnector()
Operation deleteConnector
public
deleteConnector(string $id[, string $contentType = self::contentTypes['deleteConnector'][0] ]) : void
Delete an inbox connector
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['deleteConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnector'] to see the possible values for this operation
Tags
Return values
void —deleteConnectorAsync()
Operation deleteConnectorAsync
public
deleteConnectorAsync(string $id[, string $contentType = self::contentTypes['deleteConnector'][0] ]) : PromiseInterface
Delete an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteConnectorAsyncWithHttpInfo()
Operation deleteConnectorAsyncWithHttpInfo
public
deleteConnectorAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteConnector'][0] ]) : PromiseInterface
Delete an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteConnectorImapConnection()
Operation deleteConnectorImapConnection
public
deleteConnectorImapConnection(string $id[, string $contentType = self::contentTypes['deleteConnectorImapConnection'][0] ]) : void
Delete an inbox connector IMAP connection
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['deleteConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
void —deleteConnectorImapConnectionAsync()
Operation deleteConnectorImapConnectionAsync
public
deleteConnectorImapConnectionAsync(string $id[, string $contentType = self::contentTypes['deleteConnectorImapConnection'][0] ]) : PromiseInterface
Delete an inbox connector IMAP connection
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteConnectorImapConnectionAsyncWithHttpInfo()
Operation deleteConnectorImapConnectionAsyncWithHttpInfo
public
deleteConnectorImapConnectionAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteConnectorImapConnection'][0] ]) : PromiseInterface
Delete an inbox connector IMAP connection
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteConnectorImapConnectionRequest()
Create request for operation 'deleteConnectorImapConnection'
public
deleteConnectorImapConnectionRequest(string $id[, string $contentType = self::contentTypes['deleteConnectorImapConnection'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorImapConnection'] to see the possible values for this operation
Tags
Return values
Request —deleteConnectorImapConnectionWithHttpInfo()
Operation deleteConnectorImapConnectionWithHttpInfo
public
deleteConnectorImapConnectionWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteConnectorImapConnection'][0] ]) : array<string|int, mixed>
Delete an inbox connector IMAP connection
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnectorImapConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorImapConnection'] 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)
deleteConnectorRequest()
Create request for operation 'deleteConnector'
public
deleteConnectorRequest(string $id[, string $contentType = self::contentTypes['deleteConnector'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnector'] to see the possible values for this operation
Tags
Return values
Request —deleteConnectorSmtpConnection()
Operation deleteConnectorSmtpConnection
public
deleteConnectorSmtpConnection(string $id[, string $contentType = self::contentTypes['deleteConnectorSmtpConnection'][0] ]) : void
Delete an inbox connector SMTP connection
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['deleteConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
void —deleteConnectorSmtpConnectionAsync()
Operation deleteConnectorSmtpConnectionAsync
public
deleteConnectorSmtpConnectionAsync(string $id[, string $contentType = self::contentTypes['deleteConnectorSmtpConnection'][0] ]) : PromiseInterface
Delete an inbox connector SMTP connection
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteConnectorSmtpConnectionAsyncWithHttpInfo()
Operation deleteConnectorSmtpConnectionAsyncWithHttpInfo
public
deleteConnectorSmtpConnectionAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteConnectorSmtpConnection'][0] ]) : PromiseInterface
Delete an inbox connector SMTP connection
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteConnectorSmtpConnectionRequest()
Create request for operation 'deleteConnectorSmtpConnection'
public
deleteConnectorSmtpConnectionRequest(string $id[, string $contentType = self::contentTypes['deleteConnectorSmtpConnection'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorSmtpConnection'] to see the possible values for this operation
Tags
Return values
Request —deleteConnectorSmtpConnectionWithHttpInfo()
Operation deleteConnectorSmtpConnectionWithHttpInfo
public
deleteConnectorSmtpConnectionWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteConnectorSmtpConnection'][0] ]) : array<string|int, mixed>
Delete an inbox connector SMTP connection
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnectorSmtpConnection'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnectorSmtpConnection'] 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)
deleteConnectorWithHttpInfo()
Operation deleteConnectorWithHttpInfo
public
deleteConnectorWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteConnector'][0] ]) : array<string|int, mixed>
Delete an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteConnector'] 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)
getAllConnectorSyncEvents()
Operation getAllConnectorSyncEvents
public
getAllConnectorSyncEvents(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllConnectorSyncEvents'][0] ]) : PageConnectorSyncEvents
Get all inbox connector sync events
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
PageConnectorSyncEvents —getAllConnectorSyncEventsAsync()
Operation getAllConnectorSyncEventsAsync
public
getAllConnectorSyncEventsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllConnectorSyncEvents'][0] ]) : PromiseInterface
Get all inbox connector sync events
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllConnectorSyncEventsAsyncWithHttpInfo()
Operation getAllConnectorSyncEventsAsyncWithHttpInfo
public
getAllConnectorSyncEventsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllConnectorSyncEvents'][0] ]) : PromiseInterface
Get all inbox connector sync events
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllConnectorSyncEventsRequest()
Create request for operation 'getAllConnectorSyncEvents'
public
getAllConnectorSyncEventsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllConnectorSyncEvents'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
Request —getAllConnectorSyncEventsWithHttpInfo()
Operation getAllConnectorSyncEventsWithHttpInfo
public
getAllConnectorSyncEventsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllConnectorSyncEvents'][0] ]) : array<string|int, mixed>
Get all inbox connector sync events
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageConnectorSyncEvents, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getConnector()
Operation getConnector
public
getConnector(string $id[, string $contentType = self::contentTypes['getConnector'][0] ]) : ConnectorDto
Get an inbox connector
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnector'] to see the possible values for this operation
Tags
Return values
ConnectorDto —getConnectorAsync()
Operation getConnectorAsync
public
getConnectorAsync(string $id[, string $contentType = self::contentTypes['getConnector'][0] ]) : PromiseInterface
Get an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getConnectorAsyncWithHttpInfo()
Operation getConnectorAsyncWithHttpInfo
public
getConnectorAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnector'][0] ]) : PromiseInterface
Get an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getConnectorRequest()
Create request for operation 'getConnector'
public
getConnectorRequest(string $id[, string $contentType = self::contentTypes['getConnector'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnector'] to see the possible values for this operation
Tags
Return values
Request —getConnectors()
Operation getConnectors
public
getConnectors(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectors'][0] ]) : PageConnector
Get inbox connectors
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectors'] to see the possible values for this operation
Tags
Return values
PageConnector —getConnectorsAsync()
Operation getConnectorsAsync
public
getConnectorsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectors'][0] ]) : PromiseInterface
Get inbox connectors
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectors'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getConnectorsAsyncWithHttpInfo()
Operation getConnectorsAsyncWithHttpInfo
public
getConnectorsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectors'][0] ]) : PromiseInterface
Get inbox connectors
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectors'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getConnectorsRequest()
Create request for operation 'getConnectors'
public
getConnectorsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectors'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectors'] to see the possible values for this operation
Tags
Return values
Request —getConnectorsWithHttpInfo()
Operation getConnectorsWithHttpInfo
public
getConnectorsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectors'][0] ]) : array<string|int, mixed>
Get inbox connectors
Parameters
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectors'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageConnector, HTTP status code, HTTP response headers (array of strings)
getConnectorSyncEvent()
Operation getConnectorSyncEvent
public
getConnectorSyncEvent(string $id[, string $contentType = self::contentTypes['getConnectorSyncEvent'][0] ]) : ConnectorSyncEventDto
Get an inbox connector sync event
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getConnectorSyncEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvent'] to see the possible values for this operation
Tags
Return values
ConnectorSyncEventDto —getConnectorSyncEventAsync()
Operation getConnectorSyncEventAsync
public
getConnectorSyncEventAsync(string $id[, string $contentType = self::contentTypes['getConnectorSyncEvent'][0] ]) : PromiseInterface
Get an inbox connector sync event
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getConnectorSyncEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getConnectorSyncEventAsyncWithHttpInfo()
Operation getConnectorSyncEventAsyncWithHttpInfo
public
getConnectorSyncEventAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorSyncEvent'][0] ]) : PromiseInterface
Get an inbox connector sync event
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getConnectorSyncEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getConnectorSyncEventRequest()
Create request for operation 'getConnectorSyncEvent'
public
getConnectorSyncEventRequest(string $id[, string $contentType = self::contentTypes['getConnectorSyncEvent'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getConnectorSyncEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvent'] to see the possible values for this operation
Tags
Return values
Request —getConnectorSyncEvents()
Operation getConnectorSyncEvents
public
getConnectorSyncEvents(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectorSyncEvents'][0] ]) : PageConnectorSyncEvents
Get an inbox connector sync events
Parameters
- $id : string
-
id (required)
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
PageConnectorSyncEvents —getConnectorSyncEventsAsync()
Operation getConnectorSyncEventsAsync
public
getConnectorSyncEventsAsync(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectorSyncEvents'][0] ]) : PromiseInterface
Get an inbox connector sync events
Parameters
- $id : string
-
(required)
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getConnectorSyncEventsAsyncWithHttpInfo()
Operation getConnectorSyncEventsAsyncWithHttpInfo
public
getConnectorSyncEventsAsyncWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectorSyncEvents'][0] ]) : PromiseInterface
Get an inbox connector sync events
Parameters
- $id : string
-
(required)
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getConnectorSyncEventsRequest()
Create request for operation 'getConnectorSyncEvents'
public
getConnectorSyncEventsRequest(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectorSyncEvents'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
Request —getConnectorSyncEventsWithHttpInfo()
Operation getConnectorSyncEventsWithHttpInfo
public
getConnectorSyncEventsWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getConnectorSyncEvents'][0] ]) : array<string|int, mixed>
Get an inbox connector sync events
Parameters
- $id : string
-
(required)
- $page : int
-
Optional page index in connector list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in connector list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getConnectorSyncEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageConnectorSyncEvents, HTTP status code, HTTP response headers (array of strings)
getConnectorSyncEventWithHttpInfo()
Operation getConnectorSyncEventWithHttpInfo
public
getConnectorSyncEventWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorSyncEvent'][0] ]) : array<string|int, mixed>
Get an inbox connector sync event
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getConnectorSyncEvent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnectorSyncEvent'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ConnectorSyncEventDto, HTTP status code, HTTP response headers (array of strings)
getConnectorWithHttpInfo()
Operation getConnectorWithHttpInfo
public
getConnectorWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnector'][0] ]) : array<string|int, mixed>
Get an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['getConnector'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ConnectorDto, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —syncConnector()
Operation syncConnector
public
syncConnector(string $id[, string $contentType = self::contentTypes['syncConnector'][0] ]) : ConnectorSyncRequestResult
Sync an inbox connector
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['syncConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['syncConnector'] to see the possible values for this operation
Tags
Return values
ConnectorSyncRequestResult —syncConnectorAsync()
Operation syncConnectorAsync
public
syncConnectorAsync(string $id[, string $contentType = self::contentTypes['syncConnector'][0] ]) : PromiseInterface
Sync an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['syncConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['syncConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —syncConnectorAsyncWithHttpInfo()
Operation syncConnectorAsyncWithHttpInfo
public
syncConnectorAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['syncConnector'][0] ]) : PromiseInterface
Sync an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['syncConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['syncConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —syncConnectorRequest()
Create request for operation 'syncConnector'
public
syncConnectorRequest(string $id[, string $contentType = self::contentTypes['syncConnector'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['syncConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['syncConnector'] to see the possible values for this operation
Tags
Return values
Request —syncConnectorWithHttpInfo()
Operation syncConnectorWithHttpInfo
public
syncConnectorWithHttpInfo(string $id[, string $contentType = self::contentTypes['syncConnector'][0] ]) : array<string|int, mixed>
Sync an inbox connector
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['syncConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['syncConnector'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ConnectorSyncRequestResult, HTTP status code, HTTP response headers (array of strings)
updateConnector()
Operation updateConnector
public
updateConnector(string $id, CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['updateConnector'][0] ]) : ConnectorDto
Update an inbox connector
Parameters
- $id : string
-
id (required)
- $create_connector_options : CreateConnectorOptions
-
create_connector_options (required)
- $contentType : string = self::contentTypes['updateConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateConnector'] to see the possible values for this operation
Tags
Return values
ConnectorDto —updateConnectorAsync()
Operation updateConnectorAsync
public
updateConnectorAsync(string $id, CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['updateConnector'][0] ]) : PromiseInterface
Update an inbox connector
Parameters
- $id : string
-
(required)
- $create_connector_options : CreateConnectorOptions
-
(required)
- $contentType : string = self::contentTypes['updateConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateConnectorAsyncWithHttpInfo()
Operation updateConnectorAsyncWithHttpInfo
public
updateConnectorAsyncWithHttpInfo(string $id, CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['updateConnector'][0] ]) : PromiseInterface
Update an inbox connector
Parameters
- $id : string
-
(required)
- $create_connector_options : CreateConnectorOptions
-
(required)
- $contentType : string = self::contentTypes['updateConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateConnector'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateConnectorRequest()
Create request for operation 'updateConnector'
public
updateConnectorRequest(string $id, CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['updateConnector'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $create_connector_options : CreateConnectorOptions
-
(required)
- $contentType : string = self::contentTypes['updateConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateConnector'] to see the possible values for this operation
Tags
Return values
Request —updateConnectorWithHttpInfo()
Operation updateConnectorWithHttpInfo
public
updateConnectorWithHttpInfo(string $id, CreateConnectorOptions $create_connector_options[, string $contentType = self::contentTypes['updateConnector'][0] ]) : array<string|int, mixed>
Update an inbox connector
Parameters
- $id : string
-
(required)
- $create_connector_options : CreateConnectorOptions
-
(required)
- $contentType : string = self::contentTypes['updateConnector'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateConnector'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ConnectorDto, 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