Class ConnectorControllerApi

Hierarchy

BaseAPI
- ConnectorControllerApi

Index

Constructors

Properties

Methods

Constructors

constructor

new ConnectorControllerApi(configuration?: Configuration): ConnectorControllerApi
Parameters
- configuration: Configuration = ...
Returns ConnectorControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createConnector

createConnector(requestParameters: CreateConnectorRequest, initOverrides?: RequestInit): Promise<ConnectorDto>
Sync emails between external mailboxes and MailSlurp inboxes Create an inbox connector
Parameters
- requestParameters: CreateConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorDto>

createConnectorImapConnection

createConnectorImapConnection(requestParameters: CreateConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorImapConnectionDto>
Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox Create an inbox connector IMAP connection
Parameters
- requestParameters: CreateConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorImapConnectionDto>

createConnectorImapConnectionRaw

createConnectorImapConnectionRaw(requestParameters: CreateConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorImapConnectionDto>>
Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox Create an inbox connector IMAP connection
Parameters
- requestParameters: CreateConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorImapConnectionDto>>

createConnectorRaw

createConnectorRaw(requestParameters: CreateConnectorRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorDto>>
Sync emails between external mailboxes and MailSlurp inboxes Create an inbox connector
Parameters
- requestParameters: CreateConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorDto>>

createConnectorSmtpConnection

createConnectorSmtpConnection(requestParameters: CreateConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorSmtpConnectionDto>
Allows sending via connector and email is routed to connected inbox and sent via SMTP Create an inbox connector SMTP connection
Parameters
- requestParameters: CreateConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorSmtpConnectionDto>

createConnectorSmtpConnectionRaw

createConnectorSmtpConnectionRaw(requestParameters: CreateConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorSmtpConnectionDto>>
Allows sending via connector and email is routed to connected inbox and sent via SMTP Create an inbox connector SMTP connection
Parameters
- requestParameters: CreateConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorSmtpConnectionDto>>

createConnectorSyncSettings

createConnectorSyncSettings(requestParameters: CreateConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<ConnectorSyncSettingsDto>
Configure automatic pull or emails from external inboxes using an interval or schedule Create an inbox connector sync settings
Parameters
- requestParameters: CreateConnectorSyncSettingsRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorSyncSettingsDto>

createConnectorSyncSettingsRaw

createConnectorSyncSettingsRaw(requestParameters: CreateConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorSyncSettingsDto>>
Configure automatic pull or emails from external inboxes using an interval or schedule Create an inbox connector sync settings
Parameters
- requestParameters: CreateConnectorSyncSettingsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorSyncSettingsDto>>

createConnectorWithOptions

createConnectorWithOptions(requestParameters: CreateConnectorWithOptionsRequest, initOverrides?: RequestInit): Promise<ConnectorDto>
Sync emails between external mailboxes and MailSlurp inboxes Create an inbox connector with options
Parameters
- requestParameters: CreateConnectorWithOptionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorDto>

createConnectorWithOptionsRaw

createConnectorWithOptionsRaw(requestParameters: CreateConnectorWithOptionsRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorDto>>
Sync emails between external mailboxes and MailSlurp inboxes Create an inbox connector with options
Parameters
- requestParameters: CreateConnectorWithOptionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorDto>>

deleteAllConnector

deleteAllConnector(initOverrides?: RequestInit): Promise<void>
Delete all inbox connectors
Parameters
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteAllConnectorRaw

deleteAllConnectorRaw(initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete all inbox connectors
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteConnector

deleteConnector(requestParameters: DeleteConnectorRequest, initOverrides?: RequestInit): Promise<void>
Delete an inbox connector
Parameters
- requestParameters: DeleteConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteConnectorImapConnection

deleteConnectorImapConnection(requestParameters: DeleteConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<void>
Delete IMAP connection for external inbox Delete an inbox connector IMAP connection
Parameters
- requestParameters: DeleteConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteConnectorImapConnectionRaw

deleteConnectorImapConnectionRaw(requestParameters: DeleteConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete IMAP connection for external inbox Delete an inbox connector IMAP connection
Parameters
- requestParameters: DeleteConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteConnectorRaw

deleteConnectorRaw(requestParameters: DeleteConnectorRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete an inbox connector
Parameters
- requestParameters: DeleteConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteConnectorSmtpConnection

deleteConnectorSmtpConnection(requestParameters: DeleteConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<void>
Delete SMTP connection for external inbox Delete an inbox connector SMTP connection
Parameters
- requestParameters: DeleteConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteConnectorSmtpConnectionRaw

deleteConnectorSmtpConnectionRaw(requestParameters: DeleteConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete SMTP connection for external inbox Delete an inbox connector SMTP connection
Parameters
- requestParameters: DeleteConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteConnectorSyncSettings

deleteConnectorSyncSettings(requestParameters: DeleteConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<void>
Configure automatic pull or emails from external inboxes using an interval or schedule Create an inbox connector sync settings
Parameters
- requestParameters: DeleteConnectorSyncSettingsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteConnectorSyncSettingsRaw

deleteConnectorSyncSettingsRaw(requestParameters: DeleteConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Configure automatic pull or emails from external inboxes using an interval or schedule Create an inbox connector sync settings
Parameters
- requestParameters: DeleteConnectorSyncSettingsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getAllConnectorEvents

getAllConnectorEvents(requestParameters: GetAllConnectorEventsRequest, initOverrides?: RequestInit): Promise<PageConnectorEvents>
Get all inbox connector events
Parameters
- requestParameters: GetAllConnectorEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageConnectorEvents>

getAllConnectorEventsRaw

getAllConnectorEventsRaw(requestParameters: GetAllConnectorEventsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageConnectorEvents>>
Get all inbox connector events
Parameters
- requestParameters: GetAllConnectorEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageConnectorEvents>>

getConnector

getConnector(requestParameters: GetConnectorRequest, initOverrides?: RequestInit): Promise<ConnectorDto>
Get an inbox connector
Parameters
- requestParameters: GetConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorDto>

getConnectorByEmailAddress

getConnectorByEmailAddress(requestParameters: GetConnectorByEmailAddressRequest, initOverrides?: RequestInit): Promise<OptionalConnectorDto>
Find an inbox connector by email address Get connector by email address
Parameters
- requestParameters: GetConnectorByEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<OptionalConnectorDto>

getConnectorByEmailAddressRaw

getConnectorByEmailAddressRaw(requestParameters: GetConnectorByEmailAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptionalConnectorDto>>
Find an inbox connector by email address Get connector by email address
Parameters
- requestParameters: GetConnectorByEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptionalConnectorDto>>

getConnectorByInboxId

getConnectorByInboxId(requestParameters: GetConnectorByInboxIdRequest, initOverrides?: RequestInit): Promise<OptionalConnectorDto>
Find an inbox connector by inbox ID Get connector by inbox ID
Parameters
- requestParameters: GetConnectorByInboxIdRequest
- Optional initOverrides: RequestInit
Returns Promise<OptionalConnectorDto>

getConnectorByInboxIdRaw

getConnectorByInboxIdRaw(requestParameters: GetConnectorByInboxIdRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptionalConnectorDto>>
Find an inbox connector by inbox ID Get connector by inbox ID
Parameters
- requestParameters: GetConnectorByInboxIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptionalConnectorDto>>

getConnectorByName

getConnectorByName(requestParameters: GetConnectorByNameRequest, initOverrides?: RequestInit): Promise<OptionalConnectorDto>
Find an inbox connector by name Get connector by name
Parameters
- requestParameters: GetConnectorByNameRequest
- Optional initOverrides: RequestInit
Returns Promise<OptionalConnectorDto>

getConnectorByNameRaw

getConnectorByNameRaw(requestParameters: GetConnectorByNameRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptionalConnectorDto>>
Find an inbox connector by name Get connector by name
Parameters
- requestParameters: GetConnectorByNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptionalConnectorDto>>

getConnectorEvent

getConnectorEvent(requestParameters: GetConnectorEventRequest, initOverrides?: RequestInit): Promise<ConnectorEventDto>
Get an inbox connector event
Parameters
- requestParameters: GetConnectorEventRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorEventDto>

getConnectorEventRaw

getConnectorEventRaw(requestParameters: GetConnectorEventRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorEventDto>>
Get an inbox connector event
Parameters
- requestParameters: GetConnectorEventRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorEventDto>>

getConnectorEvents

getConnectorEvents(requestParameters: GetConnectorEventsRequest, initOverrides?: RequestInit): Promise<PageConnectorEvents>
Get an inbox connector events
Parameters
- requestParameters: GetConnectorEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageConnectorEvents>

getConnectorEventsRaw

getConnectorEventsRaw(requestParameters: GetConnectorEventsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageConnectorEvents>>
Get an inbox connector events
Parameters
- requestParameters: GetConnectorEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageConnectorEvents>>

getConnectorImapConnection

getConnectorImapConnection(requestParameters: GetConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<OptionalConnectorImapConnectionDto>
Get IMAP connection for external inbox Get an inbox connector IMAP connection
Parameters
- requestParameters: GetConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<OptionalConnectorImapConnectionDto>

getConnectorImapConnectionRaw

getConnectorImapConnectionRaw(requestParameters: GetConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptionalConnectorImapConnectionDto>>
Get IMAP connection for external inbox Get an inbox connector IMAP connection
Parameters
- requestParameters: GetConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptionalConnectorImapConnectionDto>>

getConnectorProviderSettings

getConnectorProviderSettings(initOverrides?: RequestInit): Promise<ConnectorProviderSettingsDto>
Get common mail provider SMTP and IMAP connection settings Get SMTP and IMAP connection settings for common mail providers
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ConnectorProviderSettingsDto>

getConnectorProviderSettingsRaw

getConnectorProviderSettingsRaw(initOverrides?: RequestInit): Promise<ApiResponse<ConnectorProviderSettingsDto>>
Get common mail provider SMTP and IMAP connection settings Get SMTP and IMAP connection settings for common mail providers
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorProviderSettingsDto>>

getConnectorRaw

getConnectorRaw(requestParameters: GetConnectorRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorDto>>
Get an inbox connector
Parameters
- requestParameters: GetConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorDto>>

getConnectorSmtpConnection

getConnectorSmtpConnection(requestParameters: GetConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<OptionalConnectorSmtpConnectionDto>
Get SMTP connection for external inbox Get an inbox connector SMTP connection
Parameters
- requestParameters: GetConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<OptionalConnectorSmtpConnectionDto>

getConnectorSmtpConnectionRaw

getConnectorSmtpConnectionRaw(requestParameters: GetConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptionalConnectorSmtpConnectionDto>>
Get SMTP connection for external inbox Get an inbox connector SMTP connection
Parameters
- requestParameters: GetConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptionalConnectorSmtpConnectionDto>>

getConnectorSyncSettings

getConnectorSyncSettings(requestParameters: GetConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<OptionalConnectorSyncSettingsDto>
Get sync settings for connection with external inbox Get an inbox connector sync settings
Parameters
- requestParameters: GetConnectorSyncSettingsRequest
- Optional initOverrides: RequestInit
Returns Promise<OptionalConnectorSyncSettingsDto>

getConnectorSyncSettingsRaw

getConnectorSyncSettingsRaw(requestParameters: GetConnectorSyncSettingsRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptionalConnectorSyncSettingsDto>>
Get sync settings for connection with external inbox Get an inbox connector sync settings
Parameters
- requestParameters: GetConnectorSyncSettingsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptionalConnectorSyncSettingsDto>>

getConnectors

getConnectors(requestParameters: GetConnectorsRequest, initOverrides?: RequestInit): Promise<PageConnector>
List inbox connectors that sync external emails to MailSlurp inboxes Get inbox connectors
Parameters
- requestParameters: GetConnectorsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageConnector>

getConnectorsRaw

getConnectorsRaw(requestParameters: GetConnectorsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageConnector>>
List inbox connectors that sync external emails to MailSlurp inboxes Get inbox connectors
Parameters
- requestParameters: GetConnectorsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageConnector>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

sendEmailFromConnector

sendEmailFromConnector(requestParameters: SendEmailFromConnectorRequest, initOverrides?: RequestInit): Promise<SentEmailDto>
Send from an inbox connector
Parameters
- requestParameters: SendEmailFromConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<SentEmailDto>

sendEmailFromConnectorRaw

sendEmailFromConnectorRaw(requestParameters: SendEmailFromConnectorRequest, initOverrides?: RequestInit): Promise<ApiResponse<SentEmailDto>>
Send from an inbox connector
Parameters
- requestParameters: SendEmailFromConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<SentEmailDto>>

syncConnector

syncConnector(requestParameters: SyncConnectorRequest, initOverrides?: RequestInit): Promise<ConnectorSyncRequestResult>
Sync an inbox connector
Parameters
- requestParameters: SyncConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorSyncRequestResult>

syncConnectorRaw

syncConnectorRaw(requestParameters: SyncConnectorRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorSyncRequestResult>>
Sync an inbox connector
Parameters
- requestParameters: SyncConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorSyncRequestResult>>

testConnectorImapConnection

testConnectorImapConnection(requestParameters: TestConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorImapConnectionTestResult>
Test the IMAP connection for a connector Test an inbox connector IMAP connection
Parameters
- requestParameters: TestConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorImapConnectionTestResult>

testConnectorImapConnectionOptions

testConnectorImapConnectionOptions(requestParameters: TestConnectorImapConnectionOptionsRequest, initOverrides?: RequestInit): Promise<ConnectorImapConnectionTestResult>
Test the IMAP connection options for a connector Test an inbox connector IMAP connection options
Parameters
- requestParameters: TestConnectorImapConnectionOptionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorImapConnectionTestResult>

testConnectorImapConnectionOptionsRaw

testConnectorImapConnectionOptionsRaw(requestParameters: TestConnectorImapConnectionOptionsRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorImapConnectionTestResult>>
Test the IMAP connection options for a connector Test an inbox connector IMAP connection options
Parameters
- requestParameters: TestConnectorImapConnectionOptionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorImapConnectionTestResult>>

testConnectorImapConnectionRaw

testConnectorImapConnectionRaw(requestParameters: TestConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorImapConnectionTestResult>>
Test the IMAP connection for a connector Test an inbox connector IMAP connection
Parameters
- requestParameters: TestConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorImapConnectionTestResult>>

testConnectorSmtpConnection

testConnectorSmtpConnection(requestParameters: TestConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorSmtpConnectionTestResult>
Test the SMTP connection for a connector Test an inbox connector SMTP connection
Parameters
- requestParameters: TestConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorSmtpConnectionTestResult>

testConnectorSmtpConnectionOptions

testConnectorSmtpConnectionOptions(requestParameters: TestConnectorSmtpConnectionOptionsRequest, initOverrides?: RequestInit): Promise<ConnectorSmtpConnectionTestResult>
Test the SMTP connection options for a connector Test an inbox connector SMTP connection options
Parameters
- requestParameters: TestConnectorSmtpConnectionOptionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorSmtpConnectionTestResult>

testConnectorSmtpConnectionOptionsRaw

testConnectorSmtpConnectionOptionsRaw(requestParameters: TestConnectorSmtpConnectionOptionsRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorSmtpConnectionTestResult>>
Test the SMTP connection options for a connector Test an inbox connector SMTP connection options
Parameters
- requestParameters: TestConnectorSmtpConnectionOptionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorSmtpConnectionTestResult>>

testConnectorSmtpConnectionRaw

testConnectorSmtpConnectionRaw(requestParameters: TestConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorSmtpConnectionTestResult>>
Test the SMTP connection for a connector Test an inbox connector SMTP connection
Parameters
- requestParameters: TestConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorSmtpConnectionTestResult>>

updateConnector

updateConnector(requestParameters: UpdateConnectorRequest, initOverrides?: RequestInit): Promise<ConnectorDto>
Update an inbox connector
Parameters
- requestParameters: UpdateConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorDto>

updateConnectorImapConnection

updateConnectorImapConnection(requestParameters: UpdateConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorImapConnectionDto>
Update IMAP connection for external inbox Update an inbox connector IMAP connection
Parameters
- requestParameters: UpdateConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorImapConnectionDto>

updateConnectorImapConnectionRaw

updateConnectorImapConnectionRaw(requestParameters: UpdateConnectorImapConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorImapConnectionDto>>
Update IMAP connection for external inbox Update an inbox connector IMAP connection
Parameters
- requestParameters: UpdateConnectorImapConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorImapConnectionDto>>

updateConnectorRaw

updateConnectorRaw(requestParameters: UpdateConnectorRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorDto>>
Update an inbox connector
Parameters
- requestParameters: UpdateConnectorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorDto>>

updateConnectorSmtpConnection

updateConnectorSmtpConnection(requestParameters: UpdateConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ConnectorSmtpConnectionDto>
Update SMTP connection for external inbox Update an inbox connector SMTP connection
Parameters
- requestParameters: UpdateConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorSmtpConnectionDto>

updateConnectorSmtpConnectionRaw

updateConnectorSmtpConnectionRaw(requestParameters: UpdateConnectorSmtpConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorSmtpConnectionDto>>
Update SMTP connection for external inbox Update an inbox connector SMTP connection
Parameters
- requestParameters: UpdateConnectorSmtpConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorSmtpConnectionDto>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class ConnectorControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns ConnectorControllerApi

Properties

Protected configuration

Methods

createConnector

Parameters

requestParameters: CreateConnectorRequest

Optional initOverrides: RequestInit

Returns Promise<ConnectorDto>

createConnectorImapConnection

Parameters

requestParameters: CreateConnectorImapConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ConnectorImapConnectionDto>

createConnectorImapConnectionRaw

Parameters

requestParameters: CreateConnectorImapConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<ConnectorImapConnectionDto>>

createConnectorRaw

Parameters

requestParameters: CreateConnectorRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<ConnectorDto>>

createConnectorSmtpConnection

Parameters

requestParameters: CreateConnectorSmtpConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ConnectorSmtpConnectionDto>

createConnectorSmtpConnectionRaw

Parameters

requestParameters: CreateConnectorSmtpConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<ConnectorSmtpConnectionDto>>

createConnectorSyncSettings

Parameters

requestParameters: CreateConnectorSyncSettingsRequest

Optional initOverrides: RequestInit

Returns Promise<ConnectorSyncSettingsDto>

createConnectorSyncSettingsRaw

Parameters

requestParameters: CreateConnectorSyncSettingsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<ConnectorSyncSettingsDto>>

createConnectorWithOptions

Parameters

requestParameters: CreateConnectorWithOptionsRequest

Optional initOverrides: RequestInit

Returns Promise<ConnectorDto>

createConnectorWithOptionsRaw

Parameters

requestParameters: CreateConnectorWithOptionsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<ConnectorDto>>

deleteAllConnector

Parameters

Optional initOverrides: RequestInit

Returns Promise<void>

deleteAllConnectorRaw

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

deleteConnector

Parameters

requestParameters: DeleteConnectorRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteConnectorImapConnection

Parameters

requestParameters: DeleteConnectorImapConnectionRequest

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit