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(string)

Initializes a new instance of the ConnectorControllerApi class.

Declaration

public ConnectorControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

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.

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, Guid?, int)

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

Declaration

public ConnectorDto CreateConnector(CreateConnectorOptions createConnectorOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
CreateConnectorOptions	createConnectorOptions
Guid?	inboxId	Optional inbox ID to associate with the connector (optional)
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, Guid?, int, CancellationToken)

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

Declaration

public Task<ConnectorDto> CreateConnectorAsync(CreateConnectorOptions createConnectorOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateConnectorOptions	createConnectorOptions
Guid?	inboxId	Optional inbox ID to associate with the connector (optional)
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
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
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
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
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
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
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
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
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

CreateConnectorSyncSettings(Guid, CreateConnectorSyncSettingsOptions, int)

Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

Declaration

public ConnectorSyncSettingsDto CreateConnectorSyncSettings(Guid id, CreateConnectorSyncSettingsOptions createConnectorSyncSettingsOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ConnectorSyncSettingsDto	ConnectorSyncSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorSyncSettingsAsync(Guid, CreateConnectorSyncSettingsOptions, int, CancellationToken)

Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

Declaration

public Task<ConnectorSyncSettingsDto> CreateConnectorSyncSettingsAsync(Guid id, CreateConnectorSyncSettingsOptions createConnectorSyncSettingsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ConnectorSyncSettingsDto>	Task of ConnectorSyncSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorSyncSettingsWithHttpInfo(Guid, CreateConnectorSyncSettingsOptions, int)

Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

Declaration

public ApiResponse<ConnectorSyncSettingsDto> CreateConnectorSyncSettingsWithHttpInfo(Guid id, CreateConnectorSyncSettingsOptions createConnectorSyncSettingsOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ConnectorSyncSettingsDto>	ApiResponse of ConnectorSyncSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorSyncSettingsWithHttpInfoAsync(Guid, CreateConnectorSyncSettingsOptions, int, CancellationToken)

Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

Declaration

public Task<ApiResponse<ConnectorSyncSettingsDto>> CreateConnectorSyncSettingsWithHttpInfoAsync(Guid id, CreateConnectorSyncSettingsOptions createConnectorSyncSettingsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorWithHttpInfo(CreateConnectorOptions, Guid?, int)

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

Declaration

public ApiResponse<ConnectorDto> CreateConnectorWithHttpInfo(CreateConnectorOptions createConnectorOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
CreateConnectorOptions	createConnectorOptions
Guid?	inboxId	Optional inbox ID to associate with the connector (optional)
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, Guid?, int, CancellationToken)

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

Declaration

public Task<ApiResponse<ConnectorDto>> CreateConnectorWithHttpInfoAsync(CreateConnectorOptions createConnectorOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateConnectorOptions	createConnectorOptions
Guid?	inboxId	Optional inbox ID to associate with the connector (optional)
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

CreateConnectorWithOptions(CreateConnectorWithOptions, Guid?, int)

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

Declaration

public ConnectorDto CreateConnectorWithOptions(CreateConnectorWithOptions createConnectorWithOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
CreateConnectorWithOptions	createConnectorWithOptions
Guid?	inboxId	Optional inbox ID to associate with the connector (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorDto	ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateConnectorWithOptionsAsync(CreateConnectorWithOptions, Guid?, int, CancellationToken)

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

Declaration

public Task<ConnectorDto> CreateConnectorWithOptionsAsync(CreateConnectorWithOptions createConnectorWithOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateConnectorWithOptions	createConnectorWithOptions
Guid?	inboxId	Optional inbox ID to associate with the connector (optional)
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

CreateConnectorWithOptionsWithHttpInfo(CreateConnectorWithOptions, Guid?, int)

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

Declaration

public ApiResponse<ConnectorDto> CreateConnectorWithOptionsWithHttpInfo(CreateConnectorWithOptions createConnectorWithOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
CreateConnectorWithOptions	createConnectorWithOptions
Guid?	inboxId	Optional inbox ID to associate with the connector (optional)
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

CreateConnectorWithOptionsWithHttpInfoAsync(CreateConnectorWithOptions, Guid?, int, CancellationToken)

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

Declaration

public Task<ApiResponse<ConnectorDto>> CreateConnectorWithOptionsWithHttpInfoAsync(CreateConnectorWithOptions createConnectorWithOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateConnectorWithOptions	createConnectorWithOptions
Guid?	inboxId	Optional inbox ID to associate with the connector (optional)
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
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
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
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
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
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
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
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
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
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
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

DeleteConnectorSyncSettings(Guid, int)

Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteConnectorSyncSettingsAsync(Guid, int, CancellationToken)

Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

Declaration

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

Parameters

Type	Name	Description
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

DeleteConnectorSyncSettingsWithHttpInfo(Guid, int)

Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

Declaration

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

Parameters

Type	Name	Description
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

DeleteConnectorSyncSettingsWithHttpInfoAsync(Guid, int, CancellationToken)

Create an inbox connector sync settings Configure automatic pull or emails from external inboxes using an interval or schedule

Declaration

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

Parameters

Type	Name	Description
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
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
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

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

Get all inbox connector events

Declaration

public PageConnectorEvents GetAllConnectorEvents(Guid? id = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string eventType = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	id	Optional connector ID (optional)
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)
string	eventType	Filter by event type (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageConnectorEvents	PageConnectorEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all inbox connector events

Declaration

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

Parameters

Type	Name	Description
Guid?	id	Optional connector ID (optional)
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)
string	eventType	Filter by event type (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageConnectorEvents>	Task of PageConnectorEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all inbox connector events

Declaration

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

Parameters

Type	Name	Description
Guid?	id	Optional connector ID (optional)
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)
string	eventType	Filter by event type (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageConnectorEvents>	ApiResponse of PageConnectorEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get all inbox connector events

Declaration

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

Parameters

Type	Name	Description
Guid?	id	Optional connector ID (optional)
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)
string	eventType	Filter by event type (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

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

GetConnectorByEmailAddress(string, int)

Get connector by email address Find an inbox connector by email address

Declaration

public OptionalConnectorDto GetConnectorByEmailAddress(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	Email address to search for connector by
int	operationIndex	Index associated with the operation.

Returns

Type	Description
OptionalConnectorDto	OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByEmailAddressAsync(string, int, CancellationToken)

Get connector by email address Find an inbox connector by email address

Declaration

public Task<OptionalConnectorDto> GetConnectorByEmailAddressAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	Email address to search for connector by
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<OptionalConnectorDto>	Task of OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByEmailAddressWithHttpInfo(string, int)

Get connector by email address Find an inbox connector by email address

Declaration

public ApiResponse<OptionalConnectorDto> GetConnectorByEmailAddressWithHttpInfo(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress	Email address to search for connector by
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<OptionalConnectorDto>	ApiResponse of OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByEmailAddressWithHttpInfoAsync(string, int, CancellationToken)

Get connector by email address Find an inbox connector by email address

Declaration

public Task<ApiResponse<OptionalConnectorDto>> GetConnectorByEmailAddressWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress	Email address to search for connector by
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByInboxId(Guid, int)

Get connector by inbox ID Find an inbox connector by inbox ID

Declaration

public OptionalConnectorDto GetConnectorByInboxId(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	Inbox ID to search for connector by
int	operationIndex	Index associated with the operation.

Returns

Type	Description
OptionalConnectorDto	OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByInboxIdAsync(Guid, int, CancellationToken)

Get connector by inbox ID Find an inbox connector by inbox ID

Declaration

public Task<OptionalConnectorDto> GetConnectorByInboxIdAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	inboxId	Inbox ID to search for connector by
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<OptionalConnectorDto>	Task of OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByInboxIdWithHttpInfo(Guid, int)

Get connector by inbox ID Find an inbox connector by inbox ID

Declaration

public ApiResponse<OptionalConnectorDto> GetConnectorByInboxIdWithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	Inbox ID to search for connector by
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<OptionalConnectorDto>	ApiResponse of OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByInboxIdWithHttpInfoAsync(Guid, int, CancellationToken)

Get connector by inbox ID Find an inbox connector by inbox ID

Declaration

public Task<ApiResponse<OptionalConnectorDto>> GetConnectorByInboxIdWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	inboxId	Inbox ID to search for connector by
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByName(string, int)

Get connector by name Find an inbox connector by name

Declaration

public OptionalConnectorDto GetConnectorByName(string name, int operationIndex = 0)

Parameters

Type	Name	Description
string	name	Name to search for connector by
int	operationIndex	Index associated with the operation.

Returns

Type	Description
OptionalConnectorDto	OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByNameAsync(string, int, CancellationToken)

Get connector by name Find an inbox connector by name

Declaration

public Task<OptionalConnectorDto> GetConnectorByNameAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Name to search for connector by
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<OptionalConnectorDto>	Task of OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByNameWithHttpInfo(string, int)

Get connector by name Find an inbox connector by name

Declaration

public ApiResponse<OptionalConnectorDto> GetConnectorByNameWithHttpInfo(string name, int operationIndex = 0)

Parameters

Type	Name	Description
string	name	Name to search for connector by
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<OptionalConnectorDto>	ApiResponse of OptionalConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorByNameWithHttpInfoAsync(string, int, CancellationToken)

Get connector by name Find an inbox connector by name

Declaration

public Task<ApiResponse<OptionalConnectorDto>> GetConnectorByNameWithHttpInfoAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Name to search for connector by
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorEvent(Guid, int)

Get an inbox connector event

Declaration

public ConnectorEventDto GetConnectorEvent(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ConnectorEventDto	ConnectorEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorEventAsync(Guid, int, CancellationToken)

Get an inbox connector event

Declaration

public Task<ConnectorEventDto> GetConnectorEventAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ConnectorEventDto>	Task of ConnectorEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorEventWithHttpInfo(Guid, int)

Get an inbox connector event

Declaration

public ApiResponse<ConnectorEventDto> GetConnectorEventWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ConnectorEventDto>	ApiResponse of ConnectorEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorEventWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector event

Declaration

public Task<ApiResponse<ConnectorEventDto>> GetConnectorEventWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get an inbox connector events

Declaration

public PageConnectorEvents GetConnectorEvents(Guid id, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string eventType = null, int operationIndex = 0)

Parameters

Type	Name	Description
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)
string	eventType	Filter by event type (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageConnectorEvents	PageConnectorEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get an inbox connector events

Declaration

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

Parameters

Type	Name	Description
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)
string	eventType	Filter by event type (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageConnectorEvents>	Task of PageConnectorEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get an inbox connector events

Declaration

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

Parameters

Type	Name	Description
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)
string	eventType	Filter by event type (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageConnectorEvents>	ApiResponse of PageConnectorEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get an inbox connector events

Declaration

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

Parameters

Type	Name	Description
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)
string	eventType	Filter by event type (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorImapConnection(Guid, int)

Get an inbox connector IMAP connection Get IMAP connection for external inbox

Declaration

public OptionalConnectorImapConnectionDto GetConnectorImapConnection(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
OptionalConnectorImapConnectionDto	OptionalConnectorImapConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorImapConnectionAsync(Guid, int, CancellationToken)

Get an inbox connector IMAP connection Get IMAP connection for external inbox

Declaration

public Task<OptionalConnectorImapConnectionDto> GetConnectorImapConnectionAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<OptionalConnectorImapConnectionDto>	Task of OptionalConnectorImapConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorImapConnectionWithHttpInfo(Guid, int)

Get an inbox connector IMAP connection Get IMAP connection for external inbox

Declaration

public ApiResponse<OptionalConnectorImapConnectionDto> GetConnectorImapConnectionWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<OptionalConnectorImapConnectionDto>	ApiResponse of OptionalConnectorImapConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorImapConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector IMAP connection Get IMAP connection for external inbox

Declaration

public Task<ApiResponse<OptionalConnectorImapConnectionDto>> GetConnectorImapConnectionWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorProviderSettings(int)

Get SMTP and IMAP connection settings for common mail providers Get common mail provider SMTP and IMAP connection settings

Declaration

public ConnectorProviderSettingsDto GetConnectorProviderSettings(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorProviderSettingsDto	ConnectorProviderSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorProviderSettingsAsync(int, CancellationToken)

Get SMTP and IMAP connection settings for common mail providers Get common mail provider SMTP and IMAP connection settings

Declaration

public Task<ConnectorProviderSettingsDto> GetConnectorProviderSettingsAsync(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<ConnectorProviderSettingsDto>	Task of ConnectorProviderSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorProviderSettingsWithHttpInfo(int)

Get SMTP and IMAP connection settings for common mail providers Get common mail provider SMTP and IMAP connection settings

Declaration

public ApiResponse<ConnectorProviderSettingsDto> GetConnectorProviderSettingsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorProviderSettingsDto>	ApiResponse of ConnectorProviderSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorProviderSettingsWithHttpInfoAsync(int, CancellationToken)

Get SMTP and IMAP connection settings for common mail providers Get common mail provider SMTP and IMAP connection settings

Declaration

public Task<ApiResponse<ConnectorProviderSettingsDto>> GetConnectorProviderSettingsWithHttpInfoAsync(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<ConnectorProviderSettingsDto>>	Task of ApiResponse (ConnectorProviderSettingsDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSmtpConnection(Guid, int)

Get an inbox connector SMTP connection Get SMTP connection for external inbox

Declaration

public OptionalConnectorSmtpConnectionDto GetConnectorSmtpConnection(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
OptionalConnectorSmtpConnectionDto	OptionalConnectorSmtpConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSmtpConnectionAsync(Guid, int, CancellationToken)

Get an inbox connector SMTP connection Get SMTP connection for external inbox

Declaration

public Task<OptionalConnectorSmtpConnectionDto> GetConnectorSmtpConnectionAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<OptionalConnectorSmtpConnectionDto>	Task of OptionalConnectorSmtpConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSmtpConnectionWithHttpInfo(Guid, int)

Get an inbox connector SMTP connection Get SMTP connection for external inbox

Declaration

public ApiResponse<OptionalConnectorSmtpConnectionDto> GetConnectorSmtpConnectionWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<OptionalConnectorSmtpConnectionDto>	ApiResponse of OptionalConnectorSmtpConnectionDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSmtpConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector SMTP connection Get SMTP connection for external inbox

Declaration

public Task<ApiResponse<OptionalConnectorSmtpConnectionDto>> GetConnectorSmtpConnectionWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSyncSettings(Guid, int)

Get an inbox connector sync settings Get sync settings for connection with external inbox

Declaration

public OptionalConnectorSyncSettingsDto GetConnectorSyncSettings(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
OptionalConnectorSyncSettingsDto	OptionalConnectorSyncSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSyncSettingsAsync(Guid, int, CancellationToken)

Get an inbox connector sync settings Get sync settings for connection with external inbox

Declaration

public Task<OptionalConnectorSyncSettingsDto> GetConnectorSyncSettingsAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<OptionalConnectorSyncSettingsDto>	Task of OptionalConnectorSyncSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSyncSettingsWithHttpInfo(Guid, int)

Get an inbox connector sync settings Get sync settings for connection with external inbox

Declaration

public ApiResponse<OptionalConnectorSyncSettingsDto> GetConnectorSyncSettingsWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<OptionalConnectorSyncSettingsDto>	ApiResponse of OptionalConnectorSyncSettingsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConnectorSyncSettingsWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector sync settings Get sync settings for connection with external inbox

Declaration

public Task<ApiResponse<OptionalConnectorSyncSettingsDto>> GetConnectorSyncSettingsWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

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

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

SendEmailFromConnector(Guid, SendEmailOptions, bool?, int)

Send from an inbox connector

Declaration

public SentEmailDto SendEmailFromConnector(Guid id, SendEmailOptions sendEmailOptions, bool? useFallback = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
SendEmailOptions	sendEmailOptions
bool?	useFallback	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
SentEmailDto	SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendEmailFromConnectorAsync(Guid, SendEmailOptions, bool?, int, CancellationToken)

Send from an inbox connector

Declaration

public Task<SentEmailDto> SendEmailFromConnectorAsync(Guid id, SendEmailOptions sendEmailOptions, bool? useFallback = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id
SendEmailOptions	sendEmailOptions
bool?	useFallback	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SentEmailDto>	Task of SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendEmailFromConnectorWithHttpInfo(Guid, SendEmailOptions, bool?, int)

Send from an inbox connector

Declaration

public ApiResponse<SentEmailDto> SendEmailFromConnectorWithHttpInfo(Guid id, SendEmailOptions sendEmailOptions, bool? useFallback = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
SendEmailOptions	sendEmailOptions
bool?	useFallback	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<SentEmailDto>	ApiResponse of SentEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendEmailFromConnectorWithHttpInfoAsync(Guid, SendEmailOptions, bool?, int, CancellationToken)

Send from an inbox connector

Declaration

public Task<ApiResponse<SentEmailDto>> SendEmailFromConnectorWithHttpInfoAsync(Guid id, SendEmailOptions sendEmailOptions, bool? useFallback = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id
SendEmailOptions	sendEmailOptions
bool?	useFallback	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SyncConnector(Guid, DateTime?, string, bool?, int)

Sync an inbox connector

Declaration

public ConnectorSyncRequestResult SyncConnector(Guid id, DateTime? since = null, string folder = null, bool? logging = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
DateTime?	since	Date to request emails since (optional)
string	folder	Which folder to sync emails with (optional)
bool?	logging	Enable or disable logging for the sync operation (optional)
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, DateTime?, string, bool?, int, CancellationToken)

Sync an inbox connector

Declaration

public Task<ConnectorSyncRequestResult> SyncConnectorAsync(Guid id, DateTime? since = null, string folder = null, bool? logging = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id
DateTime?	since	Date to request emails since (optional)
string	folder	Which folder to sync emails with (optional)
bool?	logging	Enable or disable logging for the sync operation (optional)
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, DateTime?, string, bool?, int)

Sync an inbox connector

Declaration

public ApiResponse<ConnectorSyncRequestResult> SyncConnectorWithHttpInfo(Guid id, DateTime? since = null, string folder = null, bool? logging = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
DateTime?	since	Date to request emails since (optional)
string	folder	Which folder to sync emails with (optional)
bool?	logging	Enable or disable logging for the sync operation (optional)
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, DateTime?, string, bool?, int, CancellationToken)

Sync an inbox connector

Declaration

public Task<ApiResponse<ConnectorSyncRequestResult>> SyncConnectorWithHttpInfoAsync(Guid id, DateTime? since = null, string folder = null, bool? logging = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id
DateTime?	since	Date to request emails since (optional)
string	folder	Which folder to sync emails with (optional)
bool?	logging	Enable or disable logging for the sync operation (optional)
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

TestConnectorImapConnection(Guid, CreateConnectorImapConnectionOptions, int)

Test an inbox connector IMAP connection Test the IMAP connection for a connector

Declaration

public ConnectorImapConnectionTestResult TestConnectorImapConnection(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
CreateConnectorImapConnectionOptions	createConnectorImapConnectionOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorImapConnectionTestResult	ConnectorImapConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorImapConnectionAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Test an inbox connector IMAP connection Test the IMAP connection for a connector

Declaration

public Task<ConnectorImapConnectionTestResult> TestConnectorImapConnectionAsync(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ConnectorImapConnectionTestResult>	Task of ConnectorImapConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorImapConnectionOptions(CreateConnectorImapConnectionOptions, int)

Test an inbox connector IMAP connection options Test the IMAP connection options for a connector

Declaration

public ConnectorImapConnectionTestResult TestConnectorImapConnectionOptions(CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ConnectorImapConnectionTestResult	ConnectorImapConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorImapConnectionOptionsAsync(CreateConnectorImapConnectionOptions, int, CancellationToken)

Test an inbox connector IMAP connection options Test the IMAP connection options for a connector

Declaration

public Task<ConnectorImapConnectionTestResult> TestConnectorImapConnectionOptionsAsync(CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ConnectorImapConnectionTestResult>	Task of ConnectorImapConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorImapConnectionOptionsWithHttpInfo(CreateConnectorImapConnectionOptions, int)

Test an inbox connector IMAP connection options Test the IMAP connection options for a connector

Declaration

public ApiResponse<ConnectorImapConnectionTestResult> TestConnectorImapConnectionOptionsWithHttpInfo(CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ConnectorImapConnectionTestResult>	ApiResponse of ConnectorImapConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorImapConnectionOptionsWithHttpInfoAsync(CreateConnectorImapConnectionOptions, int, CancellationToken)

Test an inbox connector IMAP connection options Test the IMAP connection options for a connector

Declaration

public Task<ApiResponse<ConnectorImapConnectionTestResult>> TestConnectorImapConnectionOptionsWithHttpInfoAsync(CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorImapConnectionWithHttpInfo(Guid, CreateConnectorImapConnectionOptions, int)

Test an inbox connector IMAP connection Test the IMAP connection for a connector

Declaration

public ApiResponse<ConnectorImapConnectionTestResult> TestConnectorImapConnectionWithHttpInfo(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
CreateConnectorImapConnectionOptions	createConnectorImapConnectionOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorImapConnectionTestResult>	ApiResponse of ConnectorImapConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorImapConnectionWithHttpInfoAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Test an inbox connector IMAP connection Test the IMAP connection for a connector

Declaration

public Task<ApiResponse<ConnectorImapConnectionTestResult>> TestConnectorImapConnectionWithHttpInfoAsync(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorSmtpConnection(Guid, CreateConnectorSmtpConnectionOptions, int)

Test an inbox connector SMTP connection Test the SMTP connection for a connector

Declaration

public ConnectorSmtpConnectionTestResult TestConnectorSmtpConnection(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
CreateConnectorSmtpConnectionOptions	createConnectorSmtpConnectionOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorSmtpConnectionTestResult	ConnectorSmtpConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorSmtpConnectionAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Test an inbox connector SMTP connection Test the SMTP connection for a connector

Declaration

public Task<ConnectorSmtpConnectionTestResult> TestConnectorSmtpConnectionAsync(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ConnectorSmtpConnectionTestResult>	Task of ConnectorSmtpConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorSmtpConnectionOptions(CreateConnectorSmtpConnectionOptions, int)

Test an inbox connector SMTP connection options Test the SMTP connection options for a connector

Declaration

public ConnectorSmtpConnectionTestResult TestConnectorSmtpConnectionOptions(CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ConnectorSmtpConnectionTestResult	ConnectorSmtpConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorSmtpConnectionOptionsAsync(CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Test an inbox connector SMTP connection options Test the SMTP connection options for a connector

Declaration

public Task<ConnectorSmtpConnectionTestResult> TestConnectorSmtpConnectionOptionsAsync(CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ConnectorSmtpConnectionTestResult>	Task of ConnectorSmtpConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorSmtpConnectionOptionsWithHttpInfo(CreateConnectorSmtpConnectionOptions, int)

Test an inbox connector SMTP connection options Test the SMTP connection options for a connector

Declaration

public ApiResponse<ConnectorSmtpConnectionTestResult> TestConnectorSmtpConnectionOptionsWithHttpInfo(CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<ConnectorSmtpConnectionTestResult>	ApiResponse of ConnectorSmtpConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorSmtpConnectionOptionsWithHttpInfoAsync(CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Test an inbox connector SMTP connection options Test the SMTP connection options for a connector

Declaration

public Task<ApiResponse<ConnectorSmtpConnectionTestResult>> TestConnectorSmtpConnectionOptionsWithHttpInfoAsync(CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorSmtpConnectionWithHttpInfo(Guid, CreateConnectorSmtpConnectionOptions, int)

Test an inbox connector SMTP connection Test the SMTP connection for a connector

Declaration

public ApiResponse<ConnectorSmtpConnectionTestResult> TestConnectorSmtpConnectionWithHttpInfo(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
CreateConnectorSmtpConnectionOptions	createConnectorSmtpConnectionOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConnectorSmtpConnectionTestResult>	ApiResponse of ConnectorSmtpConnectionTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestConnectorSmtpConnectionWithHttpInfoAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Test an inbox connector SMTP connection Test the SMTP connection for a connector

Declaration

public Task<ApiResponse<ConnectorSmtpConnectionTestResult>> TestConnectorSmtpConnectionWithHttpInfoAsync(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

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

UpdateConnectorImapConnection(Guid, CreateConnectorImapConnectionOptions, int)

Update an inbox connector IMAP connection Update IMAP connection for external inbox

Declaration

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

Parameters

Type	Name	Description
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

UpdateConnectorImapConnectionAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Update an inbox connector IMAP connection Update IMAP connection for external inbox

Declaration

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

Parameters

Type	Name	Description
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

UpdateConnectorImapConnectionWithHttpInfo(Guid, CreateConnectorImapConnectionOptions, int)

Update an inbox connector IMAP connection Update IMAP connection for external inbox

Declaration

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

Parameters

Type	Name	Description
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

UpdateConnectorImapConnectionWithHttpInfoAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Update an inbox connector IMAP connection Update IMAP connection for external inbox

Declaration

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

Parameters

Type	Name	Description
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

UpdateConnectorSmtpConnection(Guid, CreateConnectorSmtpConnectionOptions, int)

Update an inbox connector SMTP connection Update SMTP connection for external inbox

Declaration

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

Parameters

Type	Name	Description
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

UpdateConnectorSmtpConnectionAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Update an inbox connector SMTP connection Update SMTP connection for external inbox

Declaration

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

Parameters

Type	Name	Description
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

UpdateConnectorSmtpConnectionWithHttpInfo(Guid, CreateConnectorSmtpConnectionOptions, int)

Update an inbox connector SMTP connection Update SMTP connection for external inbox

Declaration

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

Parameters

Type	Name	Description
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

UpdateConnectorSmtpConnectionWithHttpInfoAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Update an inbox connector SMTP connection Update SMTP connection for external inbox

Declaration

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

Parameters

Type	Name	Description
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

UpdateConnectorWithHttpInfo(Guid, CreateConnectorOptions, int)

Update an inbox connector

Declaration

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

Parameters

Type	Name	Description
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
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