Class ConnectorControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

ConnectorControllerApi

Implements

IConnectorControllerApi

IConnectorControllerApiSync

IConnectorControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class ConnectorControllerApi : IConnectorControllerApi, IConnectorControllerApiSync, IConnectorControllerApiAsync, IApiAccessor

Constructors

ConnectorControllerApi()

Initializes a new instance of the ConnectorControllerApi class.

Declaration

public ConnectorControllerApi()

ConnectorControllerApi(Configuration)

Initializes a new instance of the ConnectorControllerApi class using Configuration object

Declaration

public ConnectorControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

ConnectorControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the ConnectorControllerApi class using a Configuration object and client instance.

Declaration

public ConnectorControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

ConnectorControllerApi(string)

Initializes a new instance of the ConnectorControllerApi class.

Declaration

public ConnectorControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

Properties

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

CreateConnector(CreateConnectorOptions, int)

Create an inbox connector Sync emails between external mailboxes and MailSlurp inboxes

Declaration

public ConnectorDto CreateConnector(CreateConnectorOptions createConnectorOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateConnectorOptions	createConnectorOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorDto	ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorAsync(CreateConnectorOptions, int, CancellationToken)

Create an inbox connector Sync emails between external mailboxes and MailSlurp inboxes

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorImapConnection(Guid, CreateConnectorImapConnectionOptions, int)

Create an inbox connector IMAP connection Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox

Declaration

public ConnectorImapConnectionDto CreateConnectorImapConnection(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorImapConnectionOptions	createConnectorImapConnectionOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorImapConnectionDto	ConnectorImapConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorImapConnectionAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Create an inbox connector IMAP connection Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorImapConnectionWithHttpInfo(Guid, CreateConnectorImapConnectionOptions, int)

Create an inbox connector IMAP connection Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox

Declaration

public ApiResponse<ConnectorImapConnectionDto> CreateConnectorImapConnectionWithHttpInfo(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorImapConnectionOptions	createConnectorImapConnectionOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorImapConnectionDto>	ApiResponse of ConnectorImapConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorImapConnectionWithHttpInfoAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Create an inbox connector IMAP connection Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorSmtpConnection(Guid, CreateConnectorSmtpConnectionOptions, int)

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

Declaration

public ConnectorSmtpConnectionDto CreateConnectorSmtpConnection(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorSmtpConnectionOptions	createConnectorSmtpConnectionOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorSmtpConnectionDto	ConnectorSmtpConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorSmtpConnectionAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorSmtpConnectionWithHttpInfo(Guid, CreateConnectorSmtpConnectionOptions, int)

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

Declaration

public ApiResponse<ConnectorSmtpConnectionDto> CreateConnectorSmtpConnectionWithHttpInfo(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorSmtpConnectionOptions	createConnectorSmtpConnectionOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorSmtpConnectionDto>	ApiResponse of ConnectorSmtpConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorSmtpConnectionWithHttpInfoAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

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

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorWithHttpInfo(CreateConnectorOptions, int)

Create an inbox connector Sync emails between external mailboxes and MailSlurp inboxes

Declaration

public ApiResponse<ConnectorDto> CreateConnectorWithHttpInfo(CreateConnectorOptions createConnectorOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateConnectorOptions	createConnectorOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorDto>	ApiResponse of ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorWithHttpInfoAsync(CreateConnectorOptions, int, CancellationToken)

Create an inbox connector Sync emails between external mailboxes and MailSlurp inboxes

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllConnector(int)

Delete all inbox connectors

Declaration

public void DeleteAllConnector(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllConnectorAsync(int, CancellationToken)

Delete all inbox connectors

Declaration

public 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

DeleteAllConnectorWithHttpInfo(int)

Delete all inbox connectors

Declaration

public ApiResponse<object> DeleteAllConnectorWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllConnectorWithHttpInfoAsync(int, CancellationToken)

Delete all inbox connectors

Declaration

public 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

DeleteConnector(Guid, int)

Delete an inbox connector

Declaration

public void DeleteConnector(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorAsync(Guid, int, CancellationToken)

Delete an inbox connector

Declaration

public 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

DeleteConnectorImapConnection(Guid, int)

Delete an inbox connector IMAP connection Delete IMAP connection for external inbox

Declaration

public void DeleteConnectorImapConnection(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorImapConnectionAsync(Guid, int, CancellationToken)

Delete an inbox connector IMAP connection Delete IMAP connection for external inbox

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorImapConnectionWithHttpInfo(Guid, int)

Delete an inbox connector IMAP connection Delete IMAP connection for external inbox

Declaration

public ApiResponse<object> DeleteConnectorImapConnectionWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorImapConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector IMAP connection Delete IMAP connection for external inbox

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorSmtpConnection(Guid, int)

Delete an inbox connector SMTP connection Delete SMTP connection for external inbox

Declaration

public void DeleteConnectorSmtpConnection(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorSmtpConnectionAsync(Guid, int, CancellationToken)

Delete an inbox connector SMTP connection Delete SMTP connection for external inbox

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorSmtpConnectionWithHttpInfo(Guid, int)

Delete an inbox connector SMTP connection Delete SMTP connection for external inbox

Declaration

public ApiResponse<object> DeleteConnectorSmtpConnectionWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorSmtpConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector SMTP connection Delete SMTP connection for external inbox

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorWithHttpInfo(Guid, int)

Delete an inbox connector

Declaration

public ApiResponse<object> DeleteConnectorWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector

Declaration

public 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

GetAllConnectorSyncEvents(int?, int?, string, DateTime?, DateTime?, int)

Get all inbox connector sync events

Declaration

public PageConnectorSyncEvents GetAllConnectorSyncEvents(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

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.

Returns

Type	Description
PageConnectorSyncEvents	PageConnectorSyncEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all inbox connector sync events

Declaration

public 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

GetAllConnectorSyncEventsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

Get all inbox connector sync events

Declaration

public ApiResponse<PageConnectorSyncEvents> GetAllConnectorSyncEventsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<PageConnectorSyncEvents>	ApiResponse of PageConnectorSyncEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all inbox connector sync events

Declaration

public 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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetConnector(Guid, int)

Get an inbox connector

Declaration

public ConnectorDto GetConnector(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorDto	ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorAsync(Guid, int, CancellationToken)

Get an inbox connector

Declaration

public 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

GetConnectors(int?, int?, string, DateTime?, DateTime?, int)

Get inbox connectors List inbox connectors that sync external emails to MailSlurp inboxes

Declaration

public PageConnector GetConnectors(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

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.

Returns

Type	Description
PageConnector	PageConnector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get inbox connectors List inbox connectors that sync external emails to MailSlurp inboxes

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

Get inbox connectors List inbox connectors that sync external emails to MailSlurp inboxes

Declaration

public ApiResponse<PageConnector> GetConnectorsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<PageConnector>	ApiResponse of PageConnector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get inbox connectors List inbox connectors that sync external emails to MailSlurp inboxes

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSyncEvent(Guid, int)

Get an inbox connector sync event

Declaration

public ConnectorSyncEventDto GetConnectorSyncEvent(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorSyncEventDto	ConnectorSyncEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSyncEventAsync(Guid, int, CancellationToken)

Get an inbox connector sync event

Declaration

public 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

GetConnectorSyncEvents(Guid, int?, int?, string, DateTime?, DateTime?, int)

Get an inbox connector sync events

Declaration

public PageConnectorSyncEvents GetConnectorSyncEvents(Guid id, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

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.

Returns

Type	Description
PageConnectorSyncEvents	PageConnectorSyncEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get an inbox connector sync events

Declaration

public 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

GetConnectorSyncEventsWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, int)

Get an inbox connector sync events

Declaration

public ApiResponse<PageConnectorSyncEvents> GetConnectorSyncEventsWithHttpInfo(Guid id, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<PageConnectorSyncEvents>	ApiResponse of PageConnectorSyncEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get an inbox connector sync events

Declaration

public 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

GetConnectorSyncEventWithHttpInfo(Guid, int)

Get an inbox connector sync event

Declaration

public ApiResponse<ConnectorSyncEventDto> GetConnectorSyncEventWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorSyncEventDto>	ApiResponse of ConnectorSyncEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSyncEventWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector sync event

Declaration

public 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

GetConnectorWithHttpInfo(Guid, int)

Get an inbox connector

Declaration

public ApiResponse<ConnectorDto> GetConnectorWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorDto>	ApiResponse of ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector

Declaration

public 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

SyncConnector(Guid, int)

Sync an inbox connector

Declaration

public ConnectorSyncRequestResult SyncConnector(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorSyncRequestResult	ConnectorSyncRequestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SyncConnectorAsync(Guid, int, CancellationToken)

Sync an inbox connector

Declaration

public 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

SyncConnectorWithHttpInfo(Guid, int)

Sync an inbox connector

Declaration

public ApiResponse<ConnectorSyncRequestResult> SyncConnectorWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorSyncRequestResult>	ApiResponse of ConnectorSyncRequestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SyncConnectorWithHttpInfoAsync(Guid, int, CancellationToken)

Sync an inbox connector

Declaration

public 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

UpdateConnector(Guid, CreateConnectorOptions, int)

Update an inbox connector

Declaration

public ConnectorDto UpdateConnector(Guid id, CreateConnectorOptions createConnectorOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorOptions	createConnectorOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorDto	ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateConnectorAsync(Guid, CreateConnectorOptions, int, CancellationToken)

Update an inbox connector

Declaration

public 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

UpdateConnectorWithHttpInfo(Guid, CreateConnectorOptions, int)

Update an inbox connector

Declaration

public ApiResponse<ConnectorDto> UpdateConnectorWithHttpInfo(Guid id, CreateConnectorOptions createConnectorOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
CreateConnectorOptions	createConnectorOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorDto>	ApiResponse of ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateConnectorWithHttpInfoAsync(Guid, CreateConnectorOptions, int, CancellationToken)

Update an inbox connector

Declaration

public 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

Implements

IConnectorControllerApi

IConnectorControllerApiSync

IConnectorControllerApiAsync

IApiAccessor