Interface IConnectorControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IConnectorControllerApiSync : IApiAccessor

Methods

View Source

CreateConnector(CreateConnectorOptions, int)

Create an inbox connector

Declaration
ConnectorDto CreateConnector(CreateConnectorOptions createConnectorOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateConnectorOptions createConnectorOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ConnectorDto

ConnectorDto
Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateConnectorImapConnection(Guid, CreateConnectorImapConnectionOptions, int)

Create an inbox connector IMAP connection

Declaration
ConnectorImapConnectionDto CreateConnectorImapConnection(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ConnectorImapConnectionDto

ConnectorImapConnectionDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateConnectorImapConnectionWithHttpInfo(Guid, CreateConnectorImapConnectionOptions, int)

Create an inbox connector IMAP connection

Declaration
ApiResponse<ConnectorImapConnectionDto> CreateConnectorImapConnectionWithHttpInfo(Guid id, CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
CreateConnectorImapConnectionOptions createConnectorImapConnectionOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ConnectorImapConnectionDto>

ApiResponse of ConnectorImapConnectionDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateConnectorSmtpConnection(Guid, CreateConnectorSmtpConnectionOptions, int)

Create an inbox connector SMTP connection

Declaration
ConnectorSmtpConnectionDto CreateConnectorSmtpConnection(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ConnectorSmtpConnectionDto

ConnectorSmtpConnectionDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateConnectorSmtpConnectionWithHttpInfo(Guid, CreateConnectorSmtpConnectionOptions, int)

Create an inbox connector SMTP connection

Declaration
ApiResponse<ConnectorSmtpConnectionDto> CreateConnectorSmtpConnectionWithHttpInfo(Guid id, CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
CreateConnectorSmtpConnectionOptions createConnectorSmtpConnectionOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ConnectorSmtpConnectionDto>

ApiResponse of ConnectorSmtpConnectionDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateConnectorWithHttpInfo(CreateConnectorOptions, int)

Create an inbox connector

Declaration
ApiResponse<ConnectorDto> CreateConnectorWithHttpInfo(CreateConnectorOptions createConnectorOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateConnectorOptions createConnectorOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ConnectorDto>

ApiResponse of ConnectorDto
Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAllConnector(int)

Delete all inbox connectors

Declaration
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
View Source

DeleteAllConnectorWithHttpInfo(int)

Delete all inbox connectors

Declaration
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
View Source

DeleteConnector(Guid, int)

Delete an inbox connector

Declaration
void DeleteConnector(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteConnectorImapConnection(Guid, int)

Delete an inbox connector IMAP connection

Declaration
void DeleteConnectorImapConnection(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Remarks

Delete IMAP connection for external inbox

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteConnectorImapConnectionWithHttpInfo(Guid, int)

Delete an inbox connector IMAP connection

Declaration
ApiResponse<object> DeleteConnectorImapConnectionWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

Delete IMAP connection for external inbox

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteConnectorSmtpConnection(Guid, int)

Delete an inbox connector SMTP connection

Declaration
void DeleteConnectorSmtpConnection(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Remarks

Delete SMTP connection for external inbox

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteConnectorSmtpConnectionWithHttpInfo(Guid, int)

Delete an inbox connector SMTP connection

Declaration
ApiResponse<object> DeleteConnectorSmtpConnectionWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

Delete SMTP connection for external inbox

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteConnectorWithHttpInfo(Guid, int)

Delete an inbox connector

Declaration
ApiResponse<object> DeleteConnectorWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get all inbox connector sync events

Declaration
PageConnectorSyncEvents GetAllConnectorSyncEvents(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in connector list pagination (optional, default to 0)
int? size

Optional page size in connector list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageConnectorSyncEvents

PageConnectorSyncEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get all inbox connector sync events

Declaration
ApiResponse<PageConnectorSyncEvents> GetAllConnectorSyncEventsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in connector list pagination (optional, default to 0)
int? size

Optional page size in connector list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageConnectorSyncEvents>

ApiResponse of PageConnectorSyncEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetConnector(Guid, int)

Get an inbox connector

Declaration
ConnectorDto GetConnector(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ConnectorDto

ConnectorDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get inbox connectors

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

List inbox connectors that sync external emails to MailSlurp inboxes

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get inbox connectors

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

List inbox connectors that sync external emails to MailSlurp inboxes

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetConnectorSyncEvent(Guid, int)

Get an inbox connector sync event

Declaration
ConnectorSyncEventDto GetConnectorSyncEvent(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ConnectorSyncEventDto

ConnectorSyncEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get an inbox connector sync events

Declaration
PageConnectorSyncEvents GetConnectorSyncEvents(Guid id, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int? page

Optional page index in connector list pagination (optional, default to 0)
int? size

Optional page size in connector list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageConnectorSyncEvents

PageConnectorSyncEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get an inbox connector sync events

Declaration
ApiResponse<PageConnectorSyncEvents> GetConnectorSyncEventsWithHttpInfo(Guid id, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int? page

Optional page index in connector list pagination (optional, default to 0)
int? size

Optional page size in connector list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageConnectorSyncEvents>

ApiResponse of PageConnectorSyncEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetConnectorSyncEventWithHttpInfo(Guid, int)

Get an inbox connector sync event

Declaration
ApiResponse<ConnectorSyncEventDto> GetConnectorSyncEventWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ConnectorSyncEventDto>

ApiResponse of ConnectorSyncEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetConnectorWithHttpInfo(Guid, int)

Get an inbox connector

Declaration
ApiResponse<ConnectorDto> GetConnectorWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ConnectorDto>

ApiResponse of ConnectorDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SyncConnector(Guid, int)

Sync an inbox connector

Declaration
ConnectorSyncRequestResult SyncConnector(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ConnectorSyncRequestResult

ConnectorSyncRequestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SyncConnectorWithHttpInfo(Guid, int)

Sync an inbox connector

Declaration
ApiResponse<ConnectorSyncRequestResult> SyncConnectorWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ConnectorSyncRequestResult>

ApiResponse of ConnectorSyncRequestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateConnector(Guid, CreateConnectorOptions, int)

Update an inbox connector

Declaration
ConnectorDto UpdateConnector(Guid id, CreateConnectorOptions createConnectorOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
CreateConnectorOptions createConnectorOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ConnectorDto

ConnectorDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateConnectorWithHttpInfo(Guid, CreateConnectorOptions, int)

Update an inbox connector

Declaration
ApiResponse<ConnectorDto> UpdateConnectorWithHttpInfo(Guid id, CreateConnectorOptions createConnectorOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid id
CreateConnectorOptions createConnectorOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ConnectorDto>

ApiResponse of ConnectorDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call