Class ConnectorControllerApi

Hierarchy

BaseAPI
- ConnectorControllerApi

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

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

getAllConnectorSyncEvents

getAllConnectorSyncEvents(requestParameters: GetAllConnectorSyncEventsRequest, initOverrides?: RequestInit): Promise<PageConnectorSyncEvents>
Get all inbox connector sync events
Parameters
- requestParameters: GetAllConnectorSyncEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageConnectorSyncEvents>

getAllConnectorSyncEventsRaw

getAllConnectorSyncEventsRaw(requestParameters: GetAllConnectorSyncEventsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageConnectorSyncEvents>>
Get all inbox connector sync events
Parameters
- requestParameters: GetAllConnectorSyncEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageConnectorSyncEvents>>

getConnector

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

getConnectorRaw

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

getConnectorSyncEvent

getConnectorSyncEvent(requestParameters: GetConnectorSyncEventRequest, initOverrides?: RequestInit): Promise<ConnectorSyncEventDto>
Get an inbox connector sync event
Parameters
- requestParameters: GetConnectorSyncEventRequest
- Optional initOverrides: RequestInit
Returns Promise<ConnectorSyncEventDto>

getConnectorSyncEventRaw

getConnectorSyncEventRaw(requestParameters: GetConnectorSyncEventRequest, initOverrides?: RequestInit): Promise<ApiResponse<ConnectorSyncEventDto>>
Get an inbox connector sync event
Parameters
- requestParameters: GetConnectorSyncEventRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ConnectorSyncEventDto>>

getConnectorSyncEvents

getConnectorSyncEvents(requestParameters: GetConnectorSyncEventsRequest, initOverrides?: RequestInit): Promise<PageConnectorSyncEvents>
Get an inbox connector sync events
Parameters
- requestParameters: GetConnectorSyncEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageConnectorSyncEvents>

getConnectorSyncEventsRaw

getConnectorSyncEventsRaw(requestParameters: GetConnectorSyncEventsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageConnectorSyncEvents>>
Get an inbox connector sync events
Parameters
- requestParameters: GetConnectorSyncEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageConnectorSyncEvents>>

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

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

updateConnector

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

updateConnectorRaw

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

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

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

Optional initOverrides: RequestInit

Returns Promise<void>

deleteConnectorImapConnectionRaw

Parameters

requestParameters: DeleteConnectorImapConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

deleteConnectorRaw

Parameters

requestParameters: DeleteConnectorRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

deleteConnectorSmtpConnection

Parameters

requestParameters: DeleteConnectorSmtpConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteConnectorSmtpConnectionRaw

Parameters

requestParameters: DeleteConnectorSmtpConnectionRequest

`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

`Protected` request

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit