Interface IConnectorControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IConnectorControllerApiAsync : IApiAccessor

Methods

View Source

CreateConnectorAsync(CreateConnectorOptions, Guid?, int, CancellationToken)

Create an inbox connector

Declaration

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

Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorImapConnectionAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Create an inbox connector IMAP connection

Declaration

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

Parameters

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

Returns

Type	Description
Task<ConnectorImapConnectionDto>	Task of ConnectorImapConnectionDto

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorImapConnectionWithHttpInfoAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Create an inbox connector IMAP connection

Declaration

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

Parameters

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

Returns

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorSmtpConnectionAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Create an inbox connector SMTP connection

Declaration

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

Parameters

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

Returns

Type	Description
Task<ConnectorSmtpConnectionDto>	Task of ConnectorSmtpConnectionDto

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorSmtpConnectionWithHttpInfoAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Create an inbox connector SMTP connection

Declaration

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

Parameters

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

Returns

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorSyncSettingsAsync(Guid, CreateConnectorSyncSettingsOptions, int, CancellationToken)

Create an inbox connector sync settings

Declaration

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

Remarks

Configure automatic pull or emails from external inboxes using an interval or schedule

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorSyncSettingsWithHttpInfoAsync(Guid, CreateConnectorSyncSettingsOptions, int, CancellationToken)

Create an inbox connector sync settings

Declaration

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)

Remarks

Configure automatic pull or emails from external inboxes using an interval or schedule

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorWithHttpInfoAsync(CreateConnectorOptions, Guid?, int, CancellationToken)

Create an inbox connector

Declaration

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)

Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorWithOptionsAsync(CreateConnectorWithOptions, Guid?, int, CancellationToken)

Create an inbox connector with options

Declaration

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

Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorWithOptionsWithHttpInfoAsync(CreateConnectorWithOptions, Guid?, int, CancellationToken)

Create an inbox connector with options

Declaration

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)

Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllConnectorAsync(int, CancellationToken)

Delete all inbox connectors

Declaration

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

Parameters

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

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllConnectorWithHttpInfoAsync(int, CancellationToken)

Delete all inbox connectors

Declaration

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

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorAsync(Guid, int, CancellationToken)

Delete an inbox connector

Declaration

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

Parameters

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

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorImapConnectionAsync(Guid, int, CancellationToken)

Delete an inbox connector IMAP connection

Declaration

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

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorImapConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector IMAP connection

Declaration

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

Parameters

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

Returns

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

Remarks

Delete IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorSmtpConnectionAsync(Guid, int, CancellationToken)

Delete an inbox connector SMTP connection

Declaration

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

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorSmtpConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector SMTP connection

Declaration

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

Parameters

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

Returns

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

Remarks

Delete SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorSyncSettingsAsync(Guid, int, CancellationToken)

Create an inbox connector sync settings

Declaration

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

Remarks

Configure automatic pull or emails from external inboxes using an interval or schedule

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorSyncSettingsWithHttpInfoAsync(Guid, int, CancellationToken)

Create an inbox connector sync settings

Declaration

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

Remarks

Configure automatic pull or emails from external inboxes using an interval or schedule

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteConnectorWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox connector

Declaration

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

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all inbox connector events

Declaration

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

View Source

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

Get all inbox connector events

Declaration

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

View Source

GetConnectorAsync(Guid, int, CancellationToken)

Get an inbox connector

Declaration

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

Parameters

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

Returns

Type	Description
Task<ConnectorDto>	Task of ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByEmailAddressAsync(string, int, CancellationToken)

Get connector by email address

Declaration

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

Remarks

Find an inbox connector by email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByEmailAddressWithHttpInfoAsync(string, int, CancellationToken)

Get connector by email address

Declaration

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)

Remarks

Find an inbox connector by email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByInboxIdAsync(Guid, int, CancellationToken)

Get connector by inbox ID

Declaration

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

Remarks

Find an inbox connector by inbox ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByInboxIdWithHttpInfoAsync(Guid, int, CancellationToken)

Get connector by inbox ID

Declaration

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)

Remarks

Find an inbox connector by inbox ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByNameAsync(string, int, CancellationToken)

Get connector by name

Declaration

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

Remarks

Find an inbox connector by name

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByNameWithHttpInfoAsync(string, int, CancellationToken)

Get connector by name

Declaration

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)

Remarks

Find an inbox connector by name

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorEventAsync(Guid, int, CancellationToken)

Get an inbox connector event

Declaration

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

View Source

GetConnectorEventWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector event

Declaration

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

View Source

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

Get an inbox connector events

Declaration

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

View Source

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

Get an inbox connector events

Declaration

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

View Source

GetConnectorImapConnectionAsync(Guid, int, CancellationToken)

Get an inbox connector IMAP connection

Declaration

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

Remarks

Get IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorImapConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector IMAP connection

Declaration

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)

Remarks

Get IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorProviderSettingsAsync(int, CancellationToken)

Get SMTP and IMAP connection settings for common mail providers

Declaration

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

Remarks

Get common mail provider SMTP and IMAP connection settings

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorProviderSettingsWithHttpInfoAsync(int, CancellationToken)

Get SMTP and IMAP connection settings for common mail providers

Declaration

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)

Remarks

Get common mail provider SMTP and IMAP connection settings

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSmtpConnectionAsync(Guid, int, CancellationToken)

Get an inbox connector SMTP connection

Declaration

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

Remarks

Get SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSmtpConnectionWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector SMTP connection

Declaration

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)

Remarks

Get SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSyncSettingsAsync(Guid, int, CancellationToken)

Get an inbox connector sync settings

Declaration

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

Remarks

Get sync settings for connection with external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSyncSettingsWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector sync settings

Declaration

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)

Remarks

Get sync settings for connection with external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox connector

Declaration

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

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get inbox connectors

Declaration

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

Parameters

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

Returns

Type	Description
Task<PageConnector>	Task of PageConnector

Remarks

List inbox connectors that sync external emails to MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get inbox connectors

Declaration

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

Parameters

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

Returns

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

Remarks

List inbox connectors that sync external emails to MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Send from an inbox connector

Declaration

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

View Source

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

Send from an inbox connector

Declaration

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

View Source

SyncConnectorAsync(Guid, DateTime?, string, bool?, int, CancellationToken)

Sync an inbox connector

Declaration

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

View Source

SyncConnectorWithHttpInfoAsync(Guid, DateTime?, string, bool?, int, CancellationToken)

Sync an inbox connector

Declaration

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

View Source

TestConnectorImapConnectionAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Test an inbox connector IMAP connection

Declaration

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

Remarks

Test the IMAP connection for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorImapConnectionOptionsAsync(CreateConnectorImapConnectionOptions, int, CancellationToken)

Test an inbox connector IMAP connection options

Declaration

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

Remarks

Test the IMAP connection options for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorImapConnectionOptionsWithHttpInfoAsync(CreateConnectorImapConnectionOptions, int, CancellationToken)

Test an inbox connector IMAP connection options

Declaration

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)

Remarks

Test the IMAP connection options for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorImapConnectionWithHttpInfoAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Test an inbox connector IMAP connection

Declaration

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)

Remarks

Test the IMAP connection for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorSmtpConnectionAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Test an inbox connector SMTP connection

Declaration

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

Remarks

Test the SMTP connection for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorSmtpConnectionOptionsAsync(CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Test an inbox connector SMTP connection options

Declaration

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

Remarks

Test the SMTP connection options for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorSmtpConnectionOptionsWithHttpInfoAsync(CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Test an inbox connector SMTP connection options

Declaration

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)

Remarks

Test the SMTP connection options for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorSmtpConnectionWithHttpInfoAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Test an inbox connector SMTP connection

Declaration

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)

Remarks

Test the SMTP connection for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorAsync(Guid, CreateConnectorOptions, int, CancellationToken)

Update an inbox connector

Declaration

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

Parameters

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

Returns

Type	Description
Task<ConnectorDto>	Task of ConnectorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorImapConnectionAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Update an inbox connector IMAP connection

Declaration

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

Remarks

Update IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorImapConnectionWithHttpInfoAsync(Guid, CreateConnectorImapConnectionOptions, int, CancellationToken)

Update an inbox connector IMAP connection

Declaration

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)

Remarks

Update IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorSmtpConnectionAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Update an inbox connector SMTP connection

Declaration

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

Remarks

Update SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorSmtpConnectionWithHttpInfoAsync(Guid, CreateConnectorSmtpConnectionOptions, int, CancellationToken)

Update an inbox connector SMTP connection

Declaration

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)

Remarks

Update SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorWithHttpInfoAsync(Guid, CreateConnectorOptions, int, CancellationToken)

Update an inbox connector

Declaration

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

Parameters

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