Documentation

ConnectorControllerApi
in package

ConnectorControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['createConnector' => ['application/json'], 'createConnectorImapConnection' => ['application/json'], 'createConnectorSmtpConnection' => ['application/json'], 'createConnectorSyncSettings' => ['application/json'], 'createConnectorWithOptions' => ['application/json'], 'deleteAllConnector' => ['application/json'], 'deleteConnector' => ['application/json'], 'deleteConnectorImapConnection' => ['application/json'], 'deleteConnectorSmtpConnection' => ['application/json'], 'deleteConnectorSyncSettings' => ['application/json'], 'getAllConnectorEvents' => ['application/json'], 'getConnector' => ['application/json'], 'getConnectorByEmailAddress' => ['application/json'], 'getConnectorByInboxId' => ['application/json'], 'getConnectorByName' => ['application/json'], 'getConnectorEvent' => ['application/json'], 'getConnectorEvents' => ['application/json'], 'getConnectorImapConnection' => ['application/json'], 'getConnectorProviderSettings' => ['application/json'], 'getConnectorSmtpConnection' => ['application/json'], 'getConnectorSyncSettings' => ['application/json'], 'getConnectors' => ['application/json'], 'sendEmailFromConnector' => ['application/json'], 'syncConnector' => ['application/json'], 'testConnectorImapConnection' => ['application/json'], 'testConnectorImapConnectionOptions' => ['application/json'], 'testConnectorSmtpConnection' => ['application/json'], 'testConnectorSmtpConnectionOptions' => ['application/json'], 'updateConnector' => ['application/json'], 'updateConnectorImapConnection' => ['application/json'], 'updateConnectorSmtpConnection' => ['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
createConnectorSyncSettings()  : ConnectorSyncSettingsDto
Operation createConnectorSyncSettings
createConnectorSyncSettingsAsync()  : PromiseInterface
Operation createConnectorSyncSettingsAsync
createConnectorSyncSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation createConnectorSyncSettingsAsyncWithHttpInfo
createConnectorSyncSettingsRequest()  : Request
Create request for operation 'createConnectorSyncSettings'
createConnectorSyncSettingsWithHttpInfo()  : array<string|int, mixed>
Operation createConnectorSyncSettingsWithHttpInfo
createConnectorWithHttpInfo()  : array<string|int, mixed>
Operation createConnectorWithHttpInfo
createConnectorWithOptions()  : ConnectorDto
Operation createConnectorWithOptions
createConnectorWithOptionsAsync()  : PromiseInterface
Operation createConnectorWithOptionsAsync
createConnectorWithOptionsAsyncWithHttpInfo()  : PromiseInterface
Operation createConnectorWithOptionsAsyncWithHttpInfo
createConnectorWithOptionsRequest()  : Request
Create request for operation 'createConnectorWithOptions'
createConnectorWithOptionsWithHttpInfo()  : array<string|int, mixed>
Operation createConnectorWithOptionsWithHttpInfo
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
deleteConnectorSyncSettings()  : void
Operation deleteConnectorSyncSettings
deleteConnectorSyncSettingsAsync()  : PromiseInterface
Operation deleteConnectorSyncSettingsAsync
deleteConnectorSyncSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation deleteConnectorSyncSettingsAsyncWithHttpInfo
deleteConnectorSyncSettingsRequest()  : Request
Create request for operation 'deleteConnectorSyncSettings'
deleteConnectorSyncSettingsWithHttpInfo()  : array<string|int, mixed>
Operation deleteConnectorSyncSettingsWithHttpInfo
deleteConnectorWithHttpInfo()  : array<string|int, mixed>
Operation deleteConnectorWithHttpInfo
getAllConnectorEvents()  : PageConnectorEvents
Operation getAllConnectorEvents
getAllConnectorEventsAsync()  : PromiseInterface
Operation getAllConnectorEventsAsync
getAllConnectorEventsAsyncWithHttpInfo()  : PromiseInterface
Operation getAllConnectorEventsAsyncWithHttpInfo
getAllConnectorEventsRequest()  : Request
Create request for operation 'getAllConnectorEvents'
getAllConnectorEventsWithHttpInfo()  : array<string|int, mixed>
Operation getAllConnectorEventsWithHttpInfo
getConfig()  : Configuration
getConnector()  : ConnectorDto
Operation getConnector
getConnectorAsync()  : PromiseInterface
Operation getConnectorAsync
getConnectorAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorAsyncWithHttpInfo
getConnectorByEmailAddress()  : OptionalConnectorDto
Operation getConnectorByEmailAddress
getConnectorByEmailAddressAsync()  : PromiseInterface
Operation getConnectorByEmailAddressAsync
getConnectorByEmailAddressAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorByEmailAddressAsyncWithHttpInfo
getConnectorByEmailAddressRequest()  : Request
Create request for operation 'getConnectorByEmailAddress'
getConnectorByEmailAddressWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorByEmailAddressWithHttpInfo
getConnectorByInboxId()  : OptionalConnectorDto
Operation getConnectorByInboxId
getConnectorByInboxIdAsync()  : PromiseInterface
Operation getConnectorByInboxIdAsync
getConnectorByInboxIdAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorByInboxIdAsyncWithHttpInfo
getConnectorByInboxIdRequest()  : Request
Create request for operation 'getConnectorByInboxId'
getConnectorByInboxIdWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorByInboxIdWithHttpInfo
getConnectorByName()  : OptionalConnectorDto
Operation getConnectorByName
getConnectorByNameAsync()  : PromiseInterface
Operation getConnectorByNameAsync
getConnectorByNameAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorByNameAsyncWithHttpInfo
getConnectorByNameRequest()  : Request
Create request for operation 'getConnectorByName'
getConnectorByNameWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorByNameWithHttpInfo
getConnectorEvent()  : ConnectorEventDto
Operation getConnectorEvent
getConnectorEventAsync()  : PromiseInterface
Operation getConnectorEventAsync
getConnectorEventAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorEventAsyncWithHttpInfo
getConnectorEventRequest()  : Request
Create request for operation 'getConnectorEvent'
getConnectorEvents()  : PageConnectorEvents
Operation getConnectorEvents
getConnectorEventsAsync()  : PromiseInterface
Operation getConnectorEventsAsync
getConnectorEventsAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorEventsAsyncWithHttpInfo
getConnectorEventsRequest()  : Request
Create request for operation 'getConnectorEvents'
getConnectorEventsWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorEventsWithHttpInfo
getConnectorEventWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorEventWithHttpInfo
getConnectorImapConnection()  : OptionalConnectorImapConnectionDto
Operation getConnectorImapConnection
getConnectorImapConnectionAsync()  : PromiseInterface
Operation getConnectorImapConnectionAsync
getConnectorImapConnectionAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorImapConnectionAsyncWithHttpInfo
getConnectorImapConnectionRequest()  : Request
Create request for operation 'getConnectorImapConnection'
getConnectorImapConnectionWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorImapConnectionWithHttpInfo
getConnectorProviderSettings()  : ConnectorProviderSettingsDto
Operation getConnectorProviderSettings
getConnectorProviderSettingsAsync()  : PromiseInterface
Operation getConnectorProviderSettingsAsync
getConnectorProviderSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorProviderSettingsAsyncWithHttpInfo
getConnectorProviderSettingsRequest()  : Request
Create request for operation 'getConnectorProviderSettings'
getConnectorProviderSettingsWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorProviderSettingsWithHttpInfo
getConnectorRequest()  : Request
Create request for operation 'getConnector'
getConnectors()  : PageConnector
Operation getConnectors
getConnectorsAsync()  : PromiseInterface
Operation getConnectorsAsync
getConnectorsAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorsAsyncWithHttpInfo
getConnectorSmtpConnection()  : OptionalConnectorSmtpConnectionDto
Operation getConnectorSmtpConnection
getConnectorSmtpConnectionAsync()  : PromiseInterface
Operation getConnectorSmtpConnectionAsync
getConnectorSmtpConnectionAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorSmtpConnectionAsyncWithHttpInfo
getConnectorSmtpConnectionRequest()  : Request
Create request for operation 'getConnectorSmtpConnection'
getConnectorSmtpConnectionWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorSmtpConnectionWithHttpInfo
getConnectorsRequest()  : Request
Create request for operation 'getConnectors'
getConnectorsWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorsWithHttpInfo
getConnectorSyncSettings()  : OptionalConnectorSyncSettingsDto
Operation getConnectorSyncSettings
getConnectorSyncSettingsAsync()  : PromiseInterface
Operation getConnectorSyncSettingsAsync
getConnectorSyncSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation getConnectorSyncSettingsAsyncWithHttpInfo
getConnectorSyncSettingsRequest()  : Request
Create request for operation 'getConnectorSyncSettings'
getConnectorSyncSettingsWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorSyncSettingsWithHttpInfo
getConnectorWithHttpInfo()  : array<string|int, mixed>
Operation getConnectorWithHttpInfo
getHostIndex()  : int
Get the host index
sendEmailFromConnector()  : SentEmailDto
Operation sendEmailFromConnector
sendEmailFromConnectorAsync()  : PromiseInterface
Operation sendEmailFromConnectorAsync
sendEmailFromConnectorAsyncWithHttpInfo()  : PromiseInterface
Operation sendEmailFromConnectorAsyncWithHttpInfo
sendEmailFromConnectorRequest()  : Request
Create request for operation 'sendEmailFromConnector'
sendEmailFromConnectorWithHttpInfo()  : array<string|int, mixed>
Operation sendEmailFromConnectorWithHttpInfo
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
testConnectorImapConnection()  : ConnectorImapConnectionTestResult
Operation testConnectorImapConnection
testConnectorImapConnectionAsync()  : PromiseInterface
Operation testConnectorImapConnectionAsync
testConnectorImapConnectionAsyncWithHttpInfo()  : PromiseInterface
Operation testConnectorImapConnectionAsyncWithHttpInfo
testConnectorImapConnectionOptions()  : ConnectorImapConnectionTestResult
Operation testConnectorImapConnectionOptions
testConnectorImapConnectionOptionsAsync()  : PromiseInterface
Operation testConnectorImapConnectionOptionsAsync
testConnectorImapConnectionOptionsAsyncWithHttpInfo()  : PromiseInterface
Operation testConnectorImapConnectionOptionsAsyncWithHttpInfo
testConnectorImapConnectionOptionsRequest()  : Request
Create request for operation 'testConnectorImapConnectionOptions'
testConnectorImapConnectionOptionsWithHttpInfo()  : array<string|int, mixed>
Operation testConnectorImapConnectionOptionsWithHttpInfo
testConnectorImapConnectionRequest()  : Request
Create request for operation 'testConnectorImapConnection'
testConnectorImapConnectionWithHttpInfo()  : array<string|int, mixed>
Operation testConnectorImapConnectionWithHttpInfo
testConnectorSmtpConnection()  : ConnectorSmtpConnectionTestResult
Operation testConnectorSmtpConnection
testConnectorSmtpConnectionAsync()  : PromiseInterface
Operation testConnectorSmtpConnectionAsync
testConnectorSmtpConnectionAsyncWithHttpInfo()  : PromiseInterface
Operation testConnectorSmtpConnectionAsyncWithHttpInfo
testConnectorSmtpConnectionOptions()  : ConnectorSmtpConnectionTestResult
Operation testConnectorSmtpConnectionOptions
testConnectorSmtpConnectionOptionsAsync()  : PromiseInterface
Operation testConnectorSmtpConnectionOptionsAsync
testConnectorSmtpConnectionOptionsAsyncWithHttpInfo()  : PromiseInterface
Operation testConnectorSmtpConnectionOptionsAsyncWithHttpInfo
testConnectorSmtpConnectionOptionsRequest()  : Request
Create request for operation 'testConnectorSmtpConnectionOptions'
testConnectorSmtpConnectionOptionsWithHttpInfo()  : array<string|int, mixed>
Operation testConnectorSmtpConnectionOptionsWithHttpInfo
testConnectorSmtpConnectionRequest()  : Request
Create request for operation 'testConnectorSmtpConnection'
testConnectorSmtpConnectionWithHttpInfo()  : array<string|int, mixed>
Operation testConnectorSmtpConnectionWithHttpInfo
updateConnector()  : ConnectorDto
Operation updateConnector
updateConnectorAsync()  : PromiseInterface
Operation updateConnectorAsync
updateConnectorAsyncWithHttpInfo()  : PromiseInterface
Operation updateConnectorAsyncWithHttpInfo
updateConnectorImapConnection()  : ConnectorImapConnectionDto
Operation updateConnectorImapConnection
updateConnectorImapConnectionAsync()  : PromiseInterface
Operation updateConnectorImapConnectionAsync
updateConnectorImapConnectionAsyncWithHttpInfo()  : PromiseInterface
Operation updateConnectorImapConnectionAsyncWithHttpInfo
updateConnectorImapConnectionRequest()  : Request
Create request for operation 'updateConnectorImapConnection'
updateConnectorImapConnectionWithHttpInfo()  : array<string|int, mixed>
Operation updateConnectorImapConnectionWithHttpInfo
updateConnectorRequest()  : Request
Create request for operation 'updateConnector'
updateConnectorSmtpConnection()  : ConnectorSmtpConnectionDto
Operation updateConnectorSmtpConnection
updateConnectorSmtpConnectionAsync()  : PromiseInterface
Operation updateConnectorSmtpConnectionAsync
updateConnectorSmtpConnectionAsyncWithHttpInfo()  : PromiseInterface
Operation updateConnectorSmtpConnectionAsyncWithHttpInfo
updateConnectorSmtpConnectionRequest()  : Request
Create request for operation 'updateConnectorSmtpConnection'
updateConnectorSmtpConnectionWithHttpInfo()  : array<string|int, mixed>
Operation updateConnectorSmtpConnectionWithHttpInfo
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'], 'createConnectorSyncSettings' => ['application/json'], 'createConnectorWithOptions' => ['application/json'], 'deleteAllConnector' => ['application/json'], 'deleteConnector' => ['application/json'], 'deleteConnectorImapConnection' => ['application/json'], 'deleteConnectorSmtpConnection' => ['application/json'], 'deleteConnectorSyncSettings' => ['application/json'], 'getAllConnectorEvents' => ['application/json'], 'getConnector' => ['application/json'], 'getConnectorByEmailAddress' => ['application/json'], 'getConnectorByInboxId' => ['application/json'], 'getConnectorByName' => ['application/json'], 'getConnectorEvent' => ['application/json'], 'getConnectorEvents' => ['application/json'], 'getConnectorImapConnection' => ['application/json'], 'getConnectorProviderSettings' => ['application/json'], 'getConnectorSmtpConnection' => ['application/json'], 'getConnectorSyncSettings' => ['application/json'], 'getConnectors' => ['application/json'], 'sendEmailFromConnector' => ['application/json'], 'syncConnector' => ['application/json'], 'testConnectorImapConnection' => ['application/json'], 'testConnectorImapConnectionOptions' => ['application/json'], 'testConnectorSmtpConnection' => ['application/json'], 'testConnectorSmtpConnectionOptions' => ['application/json'], 'updateConnector' => ['application/json'], 'updateConnectorImapConnection' => ['application/json'], 'updateConnectorSmtpConnection' => ['application/json']]

Properties

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 $inbox_id = null ][, string $contentType = self::contentTypes['createConnector'][0] ]) : ConnectorDto

Create an inbox connector

Parameters
$create_connector_options : CreateConnectorOptions

create_connector_options (required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorDto

createConnectorAsync()

Operation createConnectorAsync

public createConnectorAsync(CreateConnectorOptions $create_connector_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createConnector'][0] ]) : PromiseInterface

Create an inbox connector

Parameters
$create_connector_options : CreateConnectorOptions

(required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$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
throws
InvalidArgumentException
Return values
PromiseInterface

createConnectorAsyncWithHttpInfo()

Operation createConnectorAsyncWithHttpInfo

public createConnectorAsyncWithHttpInfo(CreateConnectorOptions $create_connector_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createConnector'][0] ]) : PromiseInterface

Create an inbox connector

Parameters
$create_connector_options : CreateConnectorOptions

(required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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 $inbox_id = null ][, string $contentType = self::contentTypes['createConnector'][0] ]) : Request
Parameters
$create_connector_options : CreateConnectorOptions

(required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorSmtpConnectionDto, HTTP status code, HTTP response headers (array of strings)

createConnectorSyncSettings()

Operation createConnectorSyncSettings

public createConnectorSyncSettings(string $id, CreateConnectorSyncSettingsOptions $create_connector_sync_settings_options[, string $contentType = self::contentTypes['createConnectorSyncSettings'][0] ]) : ConnectorSyncSettingsDto

Create an inbox connector sync settings

Parameters
$id : string

id (required)

$create_connector_sync_settings_options : CreateConnectorSyncSettingsOptions

create_connector_sync_settings_options (required)

$contentType : string = self::contentTypes['createConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorSyncSettingsDto

createConnectorSyncSettingsAsync()

Operation createConnectorSyncSettingsAsync

public createConnectorSyncSettingsAsync(string $id, CreateConnectorSyncSettingsOptions $create_connector_sync_settings_options[, string $contentType = self::contentTypes['createConnectorSyncSettings'][0] ]) : PromiseInterface

Create an inbox connector sync settings

Parameters
$id : string

(required)

$create_connector_sync_settings_options : CreateConnectorSyncSettingsOptions

(required)

$contentType : string = self::contentTypes['createConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createConnectorSyncSettingsAsyncWithHttpInfo()

Operation createConnectorSyncSettingsAsyncWithHttpInfo

public createConnectorSyncSettingsAsyncWithHttpInfo(string $id, CreateConnectorSyncSettingsOptions $create_connector_sync_settings_options[, string $contentType = self::contentTypes['createConnectorSyncSettings'][0] ]) : PromiseInterface

Create an inbox connector sync settings

Parameters
$id : string

(required)

$create_connector_sync_settings_options : CreateConnectorSyncSettingsOptions

(required)

$contentType : string = self::contentTypes['createConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createConnectorSyncSettingsRequest()

Create request for operation 'createConnectorSyncSettings'

public createConnectorSyncSettingsRequest(string $id, CreateConnectorSyncSettingsOptions $create_connector_sync_settings_options[, string $contentType = self::contentTypes['createConnectorSyncSettings'][0] ]) : Request
Parameters
$id : string

(required)

$create_connector_sync_settings_options : CreateConnectorSyncSettingsOptions

(required)

$contentType : string = self::contentTypes['createConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createConnectorSyncSettingsWithHttpInfo()

Operation createConnectorSyncSettingsWithHttpInfo

public createConnectorSyncSettingsWithHttpInfo(string $id, CreateConnectorSyncSettingsOptions $create_connector_sync_settings_options[, string $contentType = self::contentTypes['createConnectorSyncSettings'][0] ]) : array<string|int, mixed>

Create an inbox connector sync settings

Parameters
$id : string

(required)

$create_connector_sync_settings_options : CreateConnectorSyncSettingsOptions

(required)

$contentType : string = self::contentTypes['createConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorSyncSettingsDto, HTTP status code, HTTP response headers (array of strings)

createConnectorWithHttpInfo()

Operation createConnectorWithHttpInfo

public createConnectorWithHttpInfo(CreateConnectorOptions $create_connector_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createConnector'][0] ]) : array<string|int, mixed>

Create an inbox connector

Parameters
$create_connector_options : CreateConnectorOptions

(required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorDto, HTTP status code, HTTP response headers (array of strings)

createConnectorWithOptions()

Operation createConnectorWithOptions

public createConnectorWithOptions(CreateConnectorWithOptions $create_connector_with_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createConnectorWithOptions'][0] ]) : ConnectorDto

Create an inbox connector with options

Parameters
$create_connector_with_options : CreateConnectorWithOptions

create_connector_with_options (required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$contentType : string = self::contentTypes['createConnectorWithOptions'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorWithOptions'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorDto

createConnectorWithOptionsAsync()

Operation createConnectorWithOptionsAsync

public createConnectorWithOptionsAsync(CreateConnectorWithOptions $create_connector_with_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createConnectorWithOptions'][0] ]) : PromiseInterface

Create an inbox connector with options

Parameters
$create_connector_with_options : CreateConnectorWithOptions

(required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$contentType : string = self::contentTypes['createConnectorWithOptions'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorWithOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createConnectorWithOptionsAsyncWithHttpInfo()

Operation createConnectorWithOptionsAsyncWithHttpInfo

public createConnectorWithOptionsAsyncWithHttpInfo(CreateConnectorWithOptions $create_connector_with_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createConnectorWithOptions'][0] ]) : PromiseInterface

Create an inbox connector with options

Parameters
$create_connector_with_options : CreateConnectorWithOptions

(required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$contentType : string = self::contentTypes['createConnectorWithOptions'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorWithOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createConnectorWithOptionsRequest()

Create request for operation 'createConnectorWithOptions'

public createConnectorWithOptionsRequest(CreateConnectorWithOptions $create_connector_with_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createConnectorWithOptions'][0] ]) : Request
Parameters
$create_connector_with_options : CreateConnectorWithOptions

(required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$contentType : string = self::contentTypes['createConnectorWithOptions'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorWithOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createConnectorWithOptionsWithHttpInfo()

Operation createConnectorWithOptionsWithHttpInfo

public createConnectorWithOptionsWithHttpInfo(CreateConnectorWithOptions $create_connector_with_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createConnectorWithOptions'][0] ]) : array<string|int, mixed>

Create an inbox connector with options

Parameters
$create_connector_with_options : CreateConnectorWithOptions

(required)

$inbox_id : string = null

Optional inbox ID to associate with the connector (optional)

$contentType : string = self::contentTypes['createConnectorWithOptions'][0]

The value for the Content-Type header. Check self::contentTypes['createConnectorWithOptions'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteConnectorSyncSettings()

Operation deleteConnectorSyncSettings

public deleteConnectorSyncSettings(string $id[, string $contentType = self::contentTypes['deleteConnectorSyncSettings'][0] ]) : void

Create an inbox connector sync settings

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['deleteConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['deleteConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteConnectorSyncSettingsAsync()

Operation deleteConnectorSyncSettingsAsync

public deleteConnectorSyncSettingsAsync(string $id[, string $contentType = self::contentTypes['deleteConnectorSyncSettings'][0] ]) : PromiseInterface

Create an inbox connector sync settings

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['deleteConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['deleteConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteConnectorSyncSettingsAsyncWithHttpInfo()

Operation deleteConnectorSyncSettingsAsyncWithHttpInfo

public deleteConnectorSyncSettingsAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteConnectorSyncSettings'][0] ]) : PromiseInterface

Create an inbox connector sync settings

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['deleteConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['deleteConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteConnectorSyncSettingsRequest()

Create request for operation 'deleteConnectorSyncSettings'

public deleteConnectorSyncSettingsRequest(string $id[, string $contentType = self::contentTypes['deleteConnectorSyncSettings'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['deleteConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['deleteConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteConnectorSyncSettingsWithHttpInfo()

Operation deleteConnectorSyncSettingsWithHttpInfo

public deleteConnectorSyncSettingsWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteConnectorSyncSettings'][0] ]) : array<string|int, mixed>

Create an inbox connector sync settings

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['deleteConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['deleteConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getAllConnectorEvents()

Operation getAllConnectorEvents

public getAllConnectorEvents([string $id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getAllConnectorEvents'][0] ]) : PageConnectorEvents

Get all inbox connector events

Parameters
$id : string = null

Optional connector ID (optional)

$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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getAllConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getAllConnectorEvents'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageConnectorEvents

getAllConnectorEventsAsync()

Operation getAllConnectorEventsAsync

public getAllConnectorEventsAsync([string $id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getAllConnectorEvents'][0] ]) : PromiseInterface

Get all inbox connector events

Parameters
$id : string = null

Optional connector ID (optional)

$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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getAllConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getAllConnectorEvents'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllConnectorEventsAsyncWithHttpInfo()

Operation getAllConnectorEventsAsyncWithHttpInfo

public getAllConnectorEventsAsyncWithHttpInfo([string $id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getAllConnectorEvents'][0] ]) : PromiseInterface

Get all inbox connector events

Parameters
$id : string = null

Optional connector ID (optional)

$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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getAllConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getAllConnectorEvents'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllConnectorEventsRequest()

Create request for operation 'getAllConnectorEvents'

public getAllConnectorEventsRequest([string $id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getAllConnectorEvents'][0] ]) : Request
Parameters
$id : string = null

Optional connector ID (optional)

$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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getAllConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getAllConnectorEvents'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAllConnectorEventsWithHttpInfo()

Operation getAllConnectorEventsWithHttpInfo

public getAllConnectorEventsWithHttpInfo([string $id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getAllConnectorEvents'][0] ]) : array<string|int, mixed>

Get all inbox connector events

Parameters
$id : string = null

Optional connector ID (optional)

$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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getAllConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getAllConnectorEvents'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\PageConnectorEvents, HTTP status code, HTTP response headers (array of strings)

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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorByEmailAddress()

Operation getConnectorByEmailAddress

public getConnectorByEmailAddress(string $email_address[, string $contentType = self::contentTypes['getConnectorByEmailAddress'][0] ]) : OptionalConnectorDto

Get connector by email address

Parameters
$email_address : string

Email address to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByEmailAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
OptionalConnectorDto

getConnectorByEmailAddressAsync()

Operation getConnectorByEmailAddressAsync

public getConnectorByEmailAddressAsync(string $email_address[, string $contentType = self::contentTypes['getConnectorByEmailAddress'][0] ]) : PromiseInterface

Get connector by email address

Parameters
$email_address : string

Email address to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorByEmailAddressAsyncWithHttpInfo()

Operation getConnectorByEmailAddressAsyncWithHttpInfo

public getConnectorByEmailAddressAsyncWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['getConnectorByEmailAddress'][0] ]) : PromiseInterface

Get connector by email address

Parameters
$email_address : string

Email address to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorByEmailAddressRequest()

Create request for operation 'getConnectorByEmailAddress'

public getConnectorByEmailAddressRequest(string $email_address[, string $contentType = self::contentTypes['getConnectorByEmailAddress'][0] ]) : Request
Parameters
$email_address : string

Email address to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByEmailAddress'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorByEmailAddressWithHttpInfo()

Operation getConnectorByEmailAddressWithHttpInfo

public getConnectorByEmailAddressWithHttpInfo(string $email_address[, string $contentType = self::contentTypes['getConnectorByEmailAddress'][0] ]) : array<string|int, mixed>

Get connector by email address

Parameters
$email_address : string

Email address to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByEmailAddress'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByEmailAddress'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\OptionalConnectorDto, HTTP status code, HTTP response headers (array of strings)

getConnectorByInboxId()

Operation getConnectorByInboxId

public getConnectorByInboxId(string $inbox_id[, string $contentType = self::contentTypes['getConnectorByInboxId'][0] ]) : OptionalConnectorDto

Get connector by inbox ID

Parameters
$inbox_id : string

Inbox ID to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByInboxId'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByInboxId'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
OptionalConnectorDto

getConnectorByInboxIdAsync()

Operation getConnectorByInboxIdAsync

public getConnectorByInboxIdAsync(string $inbox_id[, string $contentType = self::contentTypes['getConnectorByInboxId'][0] ]) : PromiseInterface

Get connector by inbox ID

Parameters
$inbox_id : string

Inbox ID to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByInboxId'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByInboxId'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorByInboxIdAsyncWithHttpInfo()

Operation getConnectorByInboxIdAsyncWithHttpInfo

public getConnectorByInboxIdAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getConnectorByInboxId'][0] ]) : PromiseInterface

Get connector by inbox ID

Parameters
$inbox_id : string

Inbox ID to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByInboxId'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByInboxId'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorByInboxIdRequest()

Create request for operation 'getConnectorByInboxId'

public getConnectorByInboxIdRequest(string $inbox_id[, string $contentType = self::contentTypes['getConnectorByInboxId'][0] ]) : Request
Parameters
$inbox_id : string

Inbox ID to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByInboxId'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByInboxId'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorByInboxIdWithHttpInfo()

Operation getConnectorByInboxIdWithHttpInfo

public getConnectorByInboxIdWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getConnectorByInboxId'][0] ]) : array<string|int, mixed>

Get connector by inbox ID

Parameters
$inbox_id : string

Inbox ID to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByInboxId'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByInboxId'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\OptionalConnectorDto, HTTP status code, HTTP response headers (array of strings)

getConnectorByName()

Operation getConnectorByName

public getConnectorByName(string $name[, string $contentType = self::contentTypes['getConnectorByName'][0] ]) : OptionalConnectorDto

Get connector by name

Parameters
$name : string

Name to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByName'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByName'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
OptionalConnectorDto

getConnectorByNameAsync()

Operation getConnectorByNameAsync

public getConnectorByNameAsync(string $name[, string $contentType = self::contentTypes['getConnectorByName'][0] ]) : PromiseInterface

Get connector by name

Parameters
$name : string

Name to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByName'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByName'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorByNameAsyncWithHttpInfo()

Operation getConnectorByNameAsyncWithHttpInfo

public getConnectorByNameAsyncWithHttpInfo(string $name[, string $contentType = self::contentTypes['getConnectorByName'][0] ]) : PromiseInterface

Get connector by name

Parameters
$name : string

Name to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByName'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByName'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorByNameRequest()

Create request for operation 'getConnectorByName'

public getConnectorByNameRequest(string $name[, string $contentType = self::contentTypes['getConnectorByName'][0] ]) : Request
Parameters
$name : string

Name to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByName'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByName'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorByNameWithHttpInfo()

Operation getConnectorByNameWithHttpInfo

public getConnectorByNameWithHttpInfo(string $name[, string $contentType = self::contentTypes['getConnectorByName'][0] ]) : array<string|int, mixed>

Get connector by name

Parameters
$name : string

Name to search for connector by (required)

$contentType : string = self::contentTypes['getConnectorByName'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorByName'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\OptionalConnectorDto, HTTP status code, HTTP response headers (array of strings)

getConnectorEvent()

Operation getConnectorEvent

public getConnectorEvent(string $id[, string $contentType = self::contentTypes['getConnectorEvent'][0] ]) : ConnectorEventDto

Get an inbox connector event

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getConnectorEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvent'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorEventDto

getConnectorEventAsync()

Operation getConnectorEventAsync

public getConnectorEventAsync(string $id[, string $contentType = self::contentTypes['getConnectorEvent'][0] ]) : PromiseInterface

Get an inbox connector event

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorEventAsyncWithHttpInfo()

Operation getConnectorEventAsyncWithHttpInfo

public getConnectorEventAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorEvent'][0] ]) : PromiseInterface

Get an inbox connector event

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorEventRequest()

Create request for operation 'getConnectorEvent'

public getConnectorEventRequest(string $id[, string $contentType = self::contentTypes['getConnectorEvent'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorEvents()

Operation getConnectorEvents

public getConnectorEvents(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getConnectorEvents'][0] ]) : PageConnectorEvents

Get an inbox connector 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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvents'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageConnectorEvents

getConnectorEventsAsync()

Operation getConnectorEventsAsync

public getConnectorEventsAsync(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getConnectorEvents'][0] ]) : PromiseInterface

Get an inbox connector 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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvents'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorEventsAsyncWithHttpInfo()

Operation getConnectorEventsAsyncWithHttpInfo

public getConnectorEventsAsyncWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getConnectorEvents'][0] ]) : PromiseInterface

Get an inbox connector 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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvents'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorEventsRequest()

Create request for operation 'getConnectorEvents'

public getConnectorEventsRequest(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getConnectorEvents'][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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvents'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorEventsWithHttpInfo()

Operation getConnectorEventsWithHttpInfo

public getConnectorEventsWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $event_type = null ][, string $contentType = self::contentTypes['getConnectorEvents'][0] ]) : array<string|int, mixed>

Get an inbox connector 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)

$event_type : string = null

Filter by event type (optional)

$contentType : string = self::contentTypes['getConnectorEvents'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvents'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\PageConnectorEvents, HTTP status code, HTTP response headers (array of strings)

getConnectorEventWithHttpInfo()

Operation getConnectorEventWithHttpInfo

public getConnectorEventWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorEvent'][0] ]) : array<string|int, mixed>

Get an inbox connector event

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorEvent'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorEventDto, HTTP status code, HTTP response headers (array of strings)

getConnectorImapConnection()

Operation getConnectorImapConnection

public getConnectorImapConnection(string $id[, string $contentType = self::contentTypes['getConnectorImapConnection'][0] ]) : OptionalConnectorImapConnectionDto

Get an inbox connector IMAP connection

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorImapConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
OptionalConnectorImapConnectionDto

getConnectorImapConnectionAsync()

Operation getConnectorImapConnectionAsync

public getConnectorImapConnectionAsync(string $id[, string $contentType = self::contentTypes['getConnectorImapConnection'][0] ]) : PromiseInterface

Get an inbox connector IMAP connection

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorImapConnectionAsyncWithHttpInfo()

Operation getConnectorImapConnectionAsyncWithHttpInfo

public getConnectorImapConnectionAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorImapConnection'][0] ]) : PromiseInterface

Get an inbox connector IMAP connection

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorImapConnectionRequest()

Create request for operation 'getConnectorImapConnection'

public getConnectorImapConnectionRequest(string $id[, string $contentType = self::contentTypes['getConnectorImapConnection'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorImapConnectionWithHttpInfo()

Operation getConnectorImapConnectionWithHttpInfo

public getConnectorImapConnectionWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorImapConnection'][0] ]) : array<string|int, mixed>

Get an inbox connector IMAP connection

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorImapConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\OptionalConnectorImapConnectionDto, HTTP status code, HTTP response headers (array of strings)

getConnectorProviderSettings()

Operation getConnectorProviderSettings

public getConnectorProviderSettings([string $contentType = self::contentTypes['getConnectorProviderSettings'][0] ]) : ConnectorProviderSettingsDto

Get SMTP and IMAP connection settings for common mail providers

Parameters
$contentType : string = self::contentTypes['getConnectorProviderSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorProviderSettings'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorProviderSettingsDto

getConnectorProviderSettingsAsync()

Operation getConnectorProviderSettingsAsync

public getConnectorProviderSettingsAsync([string $contentType = self::contentTypes['getConnectorProviderSettings'][0] ]) : PromiseInterface

Get SMTP and IMAP connection settings for common mail providers

Parameters
$contentType : string = self::contentTypes['getConnectorProviderSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorProviderSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorProviderSettingsAsyncWithHttpInfo()

Operation getConnectorProviderSettingsAsyncWithHttpInfo

public getConnectorProviderSettingsAsyncWithHttpInfo([string $contentType = self::contentTypes['getConnectorProviderSettings'][0] ]) : PromiseInterface

Get SMTP and IMAP connection settings for common mail providers

Parameters
$contentType : string = self::contentTypes['getConnectorProviderSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorProviderSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorProviderSettingsRequest()

Create request for operation 'getConnectorProviderSettings'

public getConnectorProviderSettingsRequest([string $contentType = self::contentTypes['getConnectorProviderSettings'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getConnectorProviderSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorProviderSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorProviderSettingsWithHttpInfo()

Operation getConnectorProviderSettingsWithHttpInfo

public getConnectorProviderSettingsWithHttpInfo([string $contentType = self::contentTypes['getConnectorProviderSettings'][0] ]) : array<string|int, mixed>

Get SMTP and IMAP connection settings for common mail providers

Parameters
$contentType : string = self::contentTypes['getConnectorProviderSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorProviderSettings'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorProviderSettingsDto, HTTP status code, HTTP response headers (array of strings)

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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorSmtpConnection()

Operation getConnectorSmtpConnection

public getConnectorSmtpConnection(string $id[, string $contentType = self::contentTypes['getConnectorSmtpConnection'][0] ]) : OptionalConnectorSmtpConnectionDto

Get an inbox connector SMTP connection

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
OptionalConnectorSmtpConnectionDto

getConnectorSmtpConnectionAsync()

Operation getConnectorSmtpConnectionAsync

public getConnectorSmtpConnectionAsync(string $id[, string $contentType = self::contentTypes['getConnectorSmtpConnection'][0] ]) : PromiseInterface

Get an inbox connector SMTP connection

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorSmtpConnectionAsyncWithHttpInfo()

Operation getConnectorSmtpConnectionAsyncWithHttpInfo

public getConnectorSmtpConnectionAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorSmtpConnection'][0] ]) : PromiseInterface

Get an inbox connector SMTP connection

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorSmtpConnectionRequest()

Create request for operation 'getConnectorSmtpConnection'

public getConnectorSmtpConnectionRequest(string $id[, string $contentType = self::contentTypes['getConnectorSmtpConnection'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorSmtpConnectionWithHttpInfo()

Operation getConnectorSmtpConnectionWithHttpInfo

public getConnectorSmtpConnectionWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorSmtpConnection'][0] ]) : array<string|int, mixed>

Get an inbox connector SMTP connection

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\OptionalConnectorSmtpConnectionDto, HTTP status code, HTTP response headers (array of strings)

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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\PageConnector, HTTP status code, HTTP response headers (array of strings)

getConnectorSyncSettings()

Operation getConnectorSyncSettings

public getConnectorSyncSettings(string $id[, string $contentType = self::contentTypes['getConnectorSyncSettings'][0] ]) : OptionalConnectorSyncSettingsDto

Get an inbox connector sync settings

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
OptionalConnectorSyncSettingsDto

getConnectorSyncSettingsAsync()

Operation getConnectorSyncSettingsAsync

public getConnectorSyncSettingsAsync(string $id[, string $contentType = self::contentTypes['getConnectorSyncSettings'][0] ]) : PromiseInterface

Get an inbox connector sync settings

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorSyncSettingsAsyncWithHttpInfo()

Operation getConnectorSyncSettingsAsyncWithHttpInfo

public getConnectorSyncSettingsAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorSyncSettings'][0] ]) : PromiseInterface

Get an inbox connector sync settings

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getConnectorSyncSettingsRequest()

Create request for operation 'getConnectorSyncSettings'

public getConnectorSyncSettingsRequest(string $id[, string $contentType = self::contentTypes['getConnectorSyncSettings'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getConnectorSyncSettingsWithHttpInfo()

Operation getConnectorSyncSettingsWithHttpInfo

public getConnectorSyncSettingsWithHttpInfo(string $id[, string $contentType = self::contentTypes['getConnectorSyncSettings'][0] ]) : array<string|int, mixed>

Get an inbox connector sync settings

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getConnectorSyncSettings'][0]

The value for the Content-Type header. Check self::contentTypes['getConnectorSyncSettings'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\OptionalConnectorSyncSettingsDto, 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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorDto, HTTP status code, HTTP response headers (array of strings)

sendEmailFromConnector()

Operation sendEmailFromConnector

public sendEmailFromConnector(string $id, SendEmailOptions $send_email_options[, bool $use_fallback = null ][, string $contentType = self::contentTypes['sendEmailFromConnector'][0] ]) : SentEmailDto

Send from an inbox connector

Parameters
$id : string

id (required)

$send_email_options : SendEmailOptions

send_email_options (required)

$use_fallback : bool = null

use_fallback (optional)

$contentType : string = self::contentTypes['sendEmailFromConnector'][0]

The value for the Content-Type header. Check self::contentTypes['sendEmailFromConnector'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
SentEmailDto

sendEmailFromConnectorAsync()

Operation sendEmailFromConnectorAsync

public sendEmailFromConnectorAsync(string $id, SendEmailOptions $send_email_options[, bool $use_fallback = null ][, string $contentType = self::contentTypes['sendEmailFromConnector'][0] ]) : PromiseInterface

Send from an inbox connector

Parameters
$id : string

(required)

$send_email_options : SendEmailOptions

(required)

$use_fallback : bool = null

(optional)

$contentType : string = self::contentTypes['sendEmailFromConnector'][0]

The value for the Content-Type header. Check self::contentTypes['sendEmailFromConnector'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

sendEmailFromConnectorAsyncWithHttpInfo()

Operation sendEmailFromConnectorAsyncWithHttpInfo

public sendEmailFromConnectorAsyncWithHttpInfo(string $id, SendEmailOptions $send_email_options[, bool $use_fallback = null ][, string $contentType = self::contentTypes['sendEmailFromConnector'][0] ]) : PromiseInterface

Send from an inbox connector

Parameters
$id : string

(required)

$send_email_options : SendEmailOptions

(required)

$use_fallback : bool = null

(optional)

$contentType : string = self::contentTypes['sendEmailFromConnector'][0]

The value for the Content-Type header. Check self::contentTypes['sendEmailFromConnector'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

sendEmailFromConnectorRequest()

Create request for operation 'sendEmailFromConnector'

public sendEmailFromConnectorRequest(string $id, SendEmailOptions $send_email_options[, bool $use_fallback = null ][, string $contentType = self::contentTypes['sendEmailFromConnector'][0] ]) : Request
Parameters
$id : string

(required)

$send_email_options : SendEmailOptions

(required)

$use_fallback : bool = null

(optional)

$contentType : string = self::contentTypes['sendEmailFromConnector'][0]

The value for the Content-Type header. Check self::contentTypes['sendEmailFromConnector'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

sendEmailFromConnectorWithHttpInfo()

Operation sendEmailFromConnectorWithHttpInfo

public sendEmailFromConnectorWithHttpInfo(string $id, SendEmailOptions $send_email_options[, bool $use_fallback = null ][, string $contentType = self::contentTypes['sendEmailFromConnector'][0] ]) : array<string|int, mixed>

Send from an inbox connector

Parameters
$id : string

(required)

$send_email_options : SendEmailOptions

(required)

$use_fallback : bool = null

(optional)

$contentType : string = self::contentTypes['sendEmailFromConnector'][0]

The value for the Content-Type header. Check self::contentTypes['sendEmailFromConnector'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\SentEmailDto, 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

syncConnector()

Operation syncConnector

public syncConnector(string $id[, DateTime $since = null ][, string $folder = null ][, bool $logging = null ][, string $contentType = self::contentTypes['syncConnector'][0] ]) : ConnectorSyncRequestResult

Sync an inbox connector

Parameters
$id : string

id (required)

$since : DateTime = null

Date to request emails since (optional)

$folder : string = null

Which folder to sync emails with (optional)

$logging : bool = null

Enable or disable logging for the sync operation (optional)

$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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorSyncRequestResult

syncConnectorAsync()

Operation syncConnectorAsync

public syncConnectorAsync(string $id[, DateTime $since = null ][, string $folder = null ][, bool $logging = null ][, string $contentType = self::contentTypes['syncConnector'][0] ]) : PromiseInterface

Sync an inbox connector

Parameters
$id : string

(required)

$since : DateTime = null

Date to request emails since (optional)

$folder : string = null

Which folder to sync emails with (optional)

$logging : bool = null

Enable or disable logging for the sync operation (optional)

$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
throws
InvalidArgumentException
Return values
PromiseInterface

syncConnectorAsyncWithHttpInfo()

Operation syncConnectorAsyncWithHttpInfo

public syncConnectorAsyncWithHttpInfo(string $id[, DateTime $since = null ][, string $folder = null ][, bool $logging = null ][, string $contentType = self::contentTypes['syncConnector'][0] ]) : PromiseInterface

Sync an inbox connector

Parameters
$id : string

(required)

$since : DateTime = null

Date to request emails since (optional)

$folder : string = null

Which folder to sync emails with (optional)

$logging : bool = null

Enable or disable logging for the sync operation (optional)

$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
throws
InvalidArgumentException
Return values
PromiseInterface

syncConnectorRequest()

Create request for operation 'syncConnector'

public syncConnectorRequest(string $id[, DateTime $since = null ][, string $folder = null ][, bool $logging = null ][, string $contentType = self::contentTypes['syncConnector'][0] ]) : Request
Parameters
$id : string

(required)

$since : DateTime = null

Date to request emails since (optional)

$folder : string = null

Which folder to sync emails with (optional)

$logging : bool = null

Enable or disable logging for the sync operation (optional)

$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
throws
InvalidArgumentException
Return values
Request

syncConnectorWithHttpInfo()

Operation syncConnectorWithHttpInfo

public syncConnectorWithHttpInfo(string $id[, DateTime $since = null ][, string $folder = null ][, bool $logging = null ][, string $contentType = self::contentTypes['syncConnector'][0] ]) : array<string|int, mixed>

Sync an inbox connector

Parameters
$id : string

(required)

$since : DateTime = null

Date to request emails since (optional)

$folder : string = null

Which folder to sync emails with (optional)

$logging : bool = null

Enable or disable logging for the sync operation (optional)

$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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorSyncRequestResult, HTTP status code, HTTP response headers (array of strings)

testConnectorImapConnection()

Operation testConnectorImapConnection

public testConnectorImapConnection(string $id[, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options = null ][, string $contentType = self::contentTypes['testConnectorImapConnection'][0] ]) : ConnectorImapConnectionTestResult

Test an inbox connector IMAP connection

Parameters
$id : string

id (required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions = null

create_connector_imap_connection_options (optional)

$contentType : string = self::contentTypes['testConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorImapConnectionTestResult

testConnectorImapConnectionAsync()

Operation testConnectorImapConnectionAsync

public testConnectorImapConnectionAsync(string $id[, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options = null ][, string $contentType = self::contentTypes['testConnectorImapConnection'][0] ]) : PromiseInterface

Test an inbox connector IMAP connection

Parameters
$id : string

(required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions = null

(optional)

$contentType : string = self::contentTypes['testConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

testConnectorImapConnectionAsyncWithHttpInfo()

Operation testConnectorImapConnectionAsyncWithHttpInfo

public testConnectorImapConnectionAsyncWithHttpInfo(string $id[, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options = null ][, string $contentType = self::contentTypes['testConnectorImapConnection'][0] ]) : PromiseInterface

Test an inbox connector IMAP connection

Parameters
$id : string

(required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions = null

(optional)

$contentType : string = self::contentTypes['testConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

testConnectorImapConnectionOptions()

Operation testConnectorImapConnectionOptions

public testConnectorImapConnectionOptions(CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['testConnectorImapConnectionOptions'][0] ]) : ConnectorImapConnectionTestResult

Test an inbox connector IMAP connection options

Parameters
$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

create_connector_imap_connection_options (required)

$contentType : string = self::contentTypes['testConnectorImapConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnectionOptions'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorImapConnectionTestResult

testConnectorImapConnectionOptionsAsync()

Operation testConnectorImapConnectionOptionsAsync

public testConnectorImapConnectionOptionsAsync(CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['testConnectorImapConnectionOptions'][0] ]) : PromiseInterface

Test an inbox connector IMAP connection options

Parameters
$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

(required)

$contentType : string = self::contentTypes['testConnectorImapConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnectionOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

testConnectorImapConnectionOptionsAsyncWithHttpInfo()

Operation testConnectorImapConnectionOptionsAsyncWithHttpInfo

public testConnectorImapConnectionOptionsAsyncWithHttpInfo(CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['testConnectorImapConnectionOptions'][0] ]) : PromiseInterface

Test an inbox connector IMAP connection options

Parameters
$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

(required)

$contentType : string = self::contentTypes['testConnectorImapConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnectionOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

testConnectorImapConnectionOptionsRequest()

Create request for operation 'testConnectorImapConnectionOptions'

public testConnectorImapConnectionOptionsRequest(CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['testConnectorImapConnectionOptions'][0] ]) : Request
Parameters
$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

(required)

$contentType : string = self::contentTypes['testConnectorImapConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnectionOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

testConnectorImapConnectionOptionsWithHttpInfo()

Operation testConnectorImapConnectionOptionsWithHttpInfo

public testConnectorImapConnectionOptionsWithHttpInfo(CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['testConnectorImapConnectionOptions'][0] ]) : array<string|int, mixed>

Test an inbox connector IMAP connection options

Parameters
$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

(required)

$contentType : string = self::contentTypes['testConnectorImapConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnectionOptions'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorImapConnectionTestResult, HTTP status code, HTTP response headers (array of strings)

testConnectorImapConnectionRequest()

Create request for operation 'testConnectorImapConnection'

public testConnectorImapConnectionRequest(string $id[, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options = null ][, string $contentType = self::contentTypes['testConnectorImapConnection'][0] ]) : Request
Parameters
$id : string

(required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions = null

(optional)

$contentType : string = self::contentTypes['testConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

testConnectorImapConnectionWithHttpInfo()

Operation testConnectorImapConnectionWithHttpInfo

public testConnectorImapConnectionWithHttpInfo(string $id[, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options = null ][, string $contentType = self::contentTypes['testConnectorImapConnection'][0] ]) : array<string|int, mixed>

Test an inbox connector IMAP connection

Parameters
$id : string

(required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions = null

(optional)

$contentType : string = self::contentTypes['testConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorImapConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorImapConnectionTestResult, HTTP status code, HTTP response headers (array of strings)

testConnectorSmtpConnection()

Operation testConnectorSmtpConnection

public testConnectorSmtpConnection(string $id[, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options = null ][, string $contentType = self::contentTypes['testConnectorSmtpConnection'][0] ]) : ConnectorSmtpConnectionTestResult

Test an inbox connector SMTP connection

Parameters
$id : string

id (required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions = null

create_connector_smtp_connection_options (optional)

$contentType : string = self::contentTypes['testConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorSmtpConnectionTestResult

testConnectorSmtpConnectionAsync()

Operation testConnectorSmtpConnectionAsync

public testConnectorSmtpConnectionAsync(string $id[, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options = null ][, string $contentType = self::contentTypes['testConnectorSmtpConnection'][0] ]) : PromiseInterface

Test an inbox connector SMTP connection

Parameters
$id : string

(required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions = null

(optional)

$contentType : string = self::contentTypes['testConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

testConnectorSmtpConnectionAsyncWithHttpInfo()

Operation testConnectorSmtpConnectionAsyncWithHttpInfo

public testConnectorSmtpConnectionAsyncWithHttpInfo(string $id[, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options = null ][, string $contentType = self::contentTypes['testConnectorSmtpConnection'][0] ]) : PromiseInterface

Test an inbox connector SMTP connection

Parameters
$id : string

(required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions = null

(optional)

$contentType : string = self::contentTypes['testConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

testConnectorSmtpConnectionOptions()

Operation testConnectorSmtpConnectionOptions

public testConnectorSmtpConnectionOptions(CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['testConnectorSmtpConnectionOptions'][0] ]) : ConnectorSmtpConnectionTestResult

Test an inbox connector SMTP connection options

Parameters
$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

create_connector_smtp_connection_options (required)

$contentType : string = self::contentTypes['testConnectorSmtpConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnectionOptions'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorSmtpConnectionTestResult

testConnectorSmtpConnectionOptionsAsync()

Operation testConnectorSmtpConnectionOptionsAsync

public testConnectorSmtpConnectionOptionsAsync(CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['testConnectorSmtpConnectionOptions'][0] ]) : PromiseInterface

Test an inbox connector SMTP connection options

Parameters
$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

(required)

$contentType : string = self::contentTypes['testConnectorSmtpConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnectionOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

testConnectorSmtpConnectionOptionsAsyncWithHttpInfo()

Operation testConnectorSmtpConnectionOptionsAsyncWithHttpInfo

public testConnectorSmtpConnectionOptionsAsyncWithHttpInfo(CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['testConnectorSmtpConnectionOptions'][0] ]) : PromiseInterface

Test an inbox connector SMTP connection options

Parameters
$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

(required)

$contentType : string = self::contentTypes['testConnectorSmtpConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnectionOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

testConnectorSmtpConnectionOptionsRequest()

Create request for operation 'testConnectorSmtpConnectionOptions'

public testConnectorSmtpConnectionOptionsRequest(CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['testConnectorSmtpConnectionOptions'][0] ]) : Request
Parameters
$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

(required)

$contentType : string = self::contentTypes['testConnectorSmtpConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnectionOptions'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

testConnectorSmtpConnectionOptionsWithHttpInfo()

Operation testConnectorSmtpConnectionOptionsWithHttpInfo

public testConnectorSmtpConnectionOptionsWithHttpInfo(CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['testConnectorSmtpConnectionOptions'][0] ]) : array<string|int, mixed>

Test an inbox connector SMTP connection options

Parameters
$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

(required)

$contentType : string = self::contentTypes['testConnectorSmtpConnectionOptions'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnectionOptions'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorSmtpConnectionTestResult, HTTP status code, HTTP response headers (array of strings)

testConnectorSmtpConnectionRequest()

Create request for operation 'testConnectorSmtpConnection'

public testConnectorSmtpConnectionRequest(string $id[, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options = null ][, string $contentType = self::contentTypes['testConnectorSmtpConnection'][0] ]) : Request
Parameters
$id : string

(required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions = null

(optional)

$contentType : string = self::contentTypes['testConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

testConnectorSmtpConnectionWithHttpInfo()

Operation testConnectorSmtpConnectionWithHttpInfo

public testConnectorSmtpConnectionWithHttpInfo(string $id[, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options = null ][, string $contentType = self::contentTypes['testConnectorSmtpConnection'][0] ]) : array<string|int, mixed>

Test an inbox connector SMTP connection

Parameters
$id : string

(required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions = null

(optional)

$contentType : string = self::contentTypes['testConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['testConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorSmtpConnectionTestResult, 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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
Return values
PromiseInterface

updateConnectorImapConnection()

Operation updateConnectorImapConnection

public updateConnectorImapConnection(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['updateConnectorImapConnection'][0] ]) : ConnectorImapConnectionDto

Update 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['updateConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorImapConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorImapConnectionDto

updateConnectorImapConnectionAsync()

Operation updateConnectorImapConnectionAsync

public updateConnectorImapConnectionAsync(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['updateConnectorImapConnection'][0] ]) : PromiseInterface

Update an inbox connector IMAP connection

Parameters
$id : string

(required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

(required)

$contentType : string = self::contentTypes['updateConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateConnectorImapConnectionAsyncWithHttpInfo()

Operation updateConnectorImapConnectionAsyncWithHttpInfo

public updateConnectorImapConnectionAsyncWithHttpInfo(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['updateConnectorImapConnection'][0] ]) : PromiseInterface

Update an inbox connector IMAP connection

Parameters
$id : string

(required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

(required)

$contentType : string = self::contentTypes['updateConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateConnectorImapConnectionRequest()

Create request for operation 'updateConnectorImapConnection'

public updateConnectorImapConnectionRequest(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['updateConnectorImapConnection'][0] ]) : Request
Parameters
$id : string

(required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

(required)

$contentType : string = self::contentTypes['updateConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorImapConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

updateConnectorImapConnectionWithHttpInfo()

Operation updateConnectorImapConnectionWithHttpInfo

public updateConnectorImapConnectionWithHttpInfo(string $id, CreateConnectorImapConnectionOptions $create_connector_imap_connection_options[, string $contentType = self::contentTypes['updateConnectorImapConnection'][0] ]) : array<string|int, mixed>

Update an inbox connector IMAP connection

Parameters
$id : string

(required)

$create_connector_imap_connection_options : CreateConnectorImapConnectionOptions

(required)

$contentType : string = self::contentTypes['updateConnectorImapConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorImapConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorImapConnectionDto, HTTP status code, HTTP response headers (array of strings)

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
throws
InvalidArgumentException
Return values
Request

updateConnectorSmtpConnection()

Operation updateConnectorSmtpConnection

public updateConnectorSmtpConnection(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['updateConnectorSmtpConnection'][0] ]) : ConnectorSmtpConnectionDto

Update 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['updateConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ConnectorSmtpConnectionDto

updateConnectorSmtpConnectionAsync()

Operation updateConnectorSmtpConnectionAsync

public updateConnectorSmtpConnectionAsync(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['updateConnectorSmtpConnection'][0] ]) : PromiseInterface

Update an inbox connector SMTP connection

Parameters
$id : string

(required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

(required)

$contentType : string = self::contentTypes['updateConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateConnectorSmtpConnectionAsyncWithHttpInfo()

Operation updateConnectorSmtpConnectionAsyncWithHttpInfo

public updateConnectorSmtpConnectionAsyncWithHttpInfo(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['updateConnectorSmtpConnection'][0] ]) : PromiseInterface

Update an inbox connector SMTP connection

Parameters
$id : string

(required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

(required)

$contentType : string = self::contentTypes['updateConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateConnectorSmtpConnectionRequest()

Create request for operation 'updateConnectorSmtpConnection'

public updateConnectorSmtpConnectionRequest(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['updateConnectorSmtpConnection'][0] ]) : Request
Parameters
$id : string

(required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

(required)

$contentType : string = self::contentTypes['updateConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

updateConnectorSmtpConnectionWithHttpInfo()

Operation updateConnectorSmtpConnectionWithHttpInfo

public updateConnectorSmtpConnectionWithHttpInfo(string $id, CreateConnectorSmtpConnectionOptions $create_connector_smtp_connection_options[, string $contentType = self::contentTypes['updateConnectorSmtpConnection'][0] ]) : array<string|int, mixed>

Update an inbox connector SMTP connection

Parameters
$id : string

(required)

$create_connector_smtp_connection_options : CreateConnectorSmtpConnectionOptions

(required)

$contentType : string = self::contentTypes['updateConnectorSmtpConnection'][0]

The value for the Content-Type header. Check self::contentTypes['updateConnectorSmtpConnection'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ConnectorSmtpConnectionDto, HTTP status code, HTTP response headers (array of strings)

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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

Search results