Interface IConnectorControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IConnectorControllerApiAsync : IApiAccessor

Methods

View Source

CreateConnectorAsync(CreateConnectorOptions, int, CancellationToken)

Create an inbox connector

Declaration

Task<ConnectorDto> CreateConnectorAsync(CreateConnectorOptions createConnectorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateConnectorOptions	createConnectorOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConnectorDto>	Task of ConnectorDto

Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorImapConnectionAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Create an inbox connector IMAP connection

Declaration

Task<ConnectorImapConnectionDto> CreateConnectorImapConnectionAsync(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorImapConnectionOptions	createConnectorImapConnectionOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConnectorImapConnectionDto>	Task of ConnectorImapConnectionDto

Remarks

Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorImapConnectionWithHttpInfoAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Create an inbox connector IMAP connection

Declaration

Task<ApiResponse<ConnectorImapConnectionDto>> CreateConnectorImapConnectionWithHttpInfoAsync(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorImapConnectionOptions	createConnectorImapConnectionOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConnectorImapConnectionDto>>	Task of ApiResponse (ConnectorImapConnectionDto)

Remarks

Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorSmtpConnectionAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Create an inbox connector SMTP connection

Declaration

Task<ConnectorSmtpConnectionDto> CreateConnectorSmtpConnectionAsync(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorSmtpConnectionOptions	createConnectorSmtpConnectionOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConnectorSmtpConnectionDto>	Task of ConnectorSmtpConnectionDto

Remarks

Allows sending via connector and email is routed to connected inbox and sent via SMTP

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorSmtpConnectionWithHttpInfoAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Create an inbox connector SMTP connection

Declaration

Task<ApiResponse<ConnectorSmtpConnectionDto>> CreateConnectorSmtpConnectionWithHttpInfoAsync(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorSmtpConnectionOptions	createConnectorSmtpConnectionOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConnectorSmtpConnectionDto>>	Task of ApiResponse (ConnectorSmtpConnectionDto)

Remarks

Allows sending via connector and email is routed to connected inbox and sent via SMTP

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorWithHttpInfoAsync(CreateConnectorOptions, int, CancellationToken)

Create an inbox connector

Declaration

Task<ApiResponse<ConnectorDto>> CreateConnectorWithHttpInfoAsync(CreateConnectorOptions createConnectorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateConnectorOptions	createConnectorOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConnectorDto>>	Task of ApiResponse (ConnectorDto)

Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllConnectorAsync(int, CancellationToken)

Delete all inbox connectors

Declaration

Task DeleteAllConnectorAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllConnectorWithHttpInfoAsync(int, CancellationToken)

Delete all inbox connectors

Declaration

Task<ApiResponse<object>> DeleteAllConnectorWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorAsync(Guid, int, CancellationToken)

Delete an inbox connector

Declaration

Task DeleteConnectorAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorImapConnectionAsync(Guid, int, CancellationToken)

Delete an inbox connector IMAP connection

Declaration

Task DeleteConnectorImapConnectionAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Remarks

Delete IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorImapConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector IMAP connection

Declaration

Task<ApiResponse<object>> DeleteConnectorImapConnectionWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Remarks

Delete IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorSmtpConnectionAsync(Guid, int, CancellationToken)

Delete an inbox connector SMTP connection

Declaration

Task DeleteConnectorSmtpConnectionAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Remarks

Delete SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorSmtpConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector SMTP connection

Declaration

Task<ApiResponse<object>> DeleteConnectorSmtpConnectionWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Remarks

Delete SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector

Declaration

Task<ApiResponse<object>> DeleteConnectorWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllConnectorSyncEventsAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all inbox connector sync events

Declaration

Task<PageConnectorSyncEvents> GetAllConnectorSyncEventsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in connector list pagination (optional, default to 0)
int?	size	Optional page size in connector list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageConnectorSyncEvents>	Task of PageConnectorSyncEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllConnectorSyncEventsWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all inbox connector sync events

Declaration

Task<ApiResponse<PageConnectorSyncEvents>> GetAllConnectorSyncEventsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in connector list pagination (optional, default to 0)
int?	size	Optional page size in connector list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageConnectorSyncEvents>>	Task of ApiResponse (PageConnectorSyncEvents)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorAsync(Guid, int, CancellationToken)

Get an inbox connector

Declaration

Task<ConnectorDto> GetConnectorAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConnectorDto>	Task of ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorsAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get inbox connectors

Declaration

Task<PageConnector> GetConnectorsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in connector list pagination (optional, default to 0)
int?	size	Optional page size in connector list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageConnector>	Task of PageConnector

Remarks

List inbox connectors that sync external emails to MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorsWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get inbox connectors

Declaration

Task<ApiResponse<PageConnector>> GetConnectorsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index in connector list pagination (optional, default to 0)
int?	size	Optional page size in connector list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageConnector>>	Task of ApiResponse (PageConnector)

Remarks

List inbox connectors that sync external emails to MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSyncEventAsync(Guid, int, CancellationToken)

Get an inbox connector sync event

Declaration

Task<ConnectorSyncEventDto> GetConnectorSyncEventAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConnectorSyncEventDto>	Task of ConnectorSyncEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSyncEventsAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get an inbox connector sync events

Declaration

Task<PageConnectorSyncEvents> GetConnectorSyncEventsAsync(Guid id, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int?	page	Optional page index in connector list pagination (optional, default to 0)
int?	size	Optional page size in connector list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageConnectorSyncEvents>	Task of PageConnectorSyncEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSyncEventsWithHttpInfoAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get an inbox connector sync events

Declaration

Task<ApiResponse<PageConnectorSyncEvents>> GetConnectorSyncEventsWithHttpInfoAsync(Guid id, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int?	page	Optional page index in connector list pagination (optional, default to 0)
int?	size	Optional page size in connector list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageConnectorSyncEvents>>	Task of ApiResponse (PageConnectorSyncEvents)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSyncEventWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector sync event

Declaration

Task<ApiResponse<ConnectorSyncEventDto>> GetConnectorSyncEventWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConnectorSyncEventDto>>	Task of ApiResponse (ConnectorSyncEventDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector

Declaration

Task<ApiResponse<ConnectorDto>> GetConnectorWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConnectorDto>>	Task of ApiResponse (ConnectorDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SyncConnectorAsync(Guid, int, CancellationToken)

Sync an inbox connector

Declaration

Task<ConnectorSyncRequestResult> SyncConnectorAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConnectorSyncRequestResult>	Task of ConnectorSyncRequestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SyncConnectorWithHttpInfoAsync(Guid, int, CancellationToken)

Sync an inbox connector

Declaration

Task<ApiResponse<ConnectorSyncRequestResult>> SyncConnectorWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConnectorSyncRequestResult>>	Task of ApiResponse (ConnectorSyncRequestResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorAsync(Guid, CreateConnectorOptions, int, CancellationToken)

Update an inbox connector

Declaration

Task<ConnectorDto> UpdateConnectorAsync(Guid id, CreateConnectorOptions createConnectorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorOptions	createConnectorOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConnectorDto>	Task of ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorWithHttpInfoAsync(Guid, CreateConnectorOptions, int, CancellationToken)

Update an inbox connector

Declaration

Task<ApiResponse<ConnectorDto>> UpdateConnectorWithHttpInfoAsync(Guid id, CreateConnectorOptions createConnectorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorOptions	createConnectorOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConnectorDto>>	Task of ApiResponse (ConnectorDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call