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

Create an inbox connector

Declaration

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

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

CreateConnectorSyncSettings(Guid, CreateConnectorSyncSettingsOptions, int)

Create an inbox connector sync settings

Declaration

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

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

CreateConnectorSyncSettingsWithHttpInfo(Guid, CreateConnectorSyncSettingsOptions, int)

Create an inbox connector sync settings

Declaration

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

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

CreateConnectorWithHttpInfo(CreateConnectorOptions, Guid?, int)

Create an inbox connector

Declaration

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

Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorWithOptions(CreateConnectorWithOptions, Guid?, int)

Create an inbox connector with options

Declaration

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

Remarks

Sync emails between external mailboxes and MailSlurp inboxes

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateConnectorWithOptionsWithHttpInfo(CreateConnectorWithOptions, Guid?, int)

Create an inbox connector with options

Declaration

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

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

DeleteConnectorSyncSettings(Guid, int)

Create an inbox connector sync settings

Declaration

void DeleteConnectorSyncSettings(Guid id, int operationIndex = 0)

Parameters

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

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

DeleteConnectorSyncSettingsWithHttpInfo(Guid, int)

Create an inbox connector sync settings

Declaration

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)

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

DeleteConnectorWithHttpInfo(Guid, int)

Delete an inbox connector

Declaration

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

View Source

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

Get all inbox connector events

Declaration

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

View Source

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

Get all inbox connector events

Declaration

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

View Source

GetConnector(Guid, int)

Get an inbox connector

Declaration

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

View Source

GetConnectorByEmailAddress(string, int)

Get connector by email address

Declaration

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

Remarks

Find an inbox connector by email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByEmailAddressWithHttpInfo(string, int)

Get connector by email address

Declaration

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

Remarks

Find an inbox connector by email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByInboxId(Guid, int)

Get connector by inbox ID

Declaration

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

Remarks

Find an inbox connector by inbox ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByInboxIdWithHttpInfo(Guid, int)

Get connector by inbox ID

Declaration

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

Remarks

Find an inbox connector by inbox ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByName(string, int)

Get connector by name

Declaration

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

Remarks

Find an inbox connector by name

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorByNameWithHttpInfo(string, int)

Get connector by name

Declaration

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

Remarks

Find an inbox connector by name

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorEvent(Guid, int)

Get an inbox connector event

Declaration

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

View Source

GetConnectorEventWithHttpInfo(Guid, int)

Get an inbox connector event

Declaration

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

View Source

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

Get an inbox connector events

Declaration

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

View Source

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

Get an inbox connector events

Declaration

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

View Source

GetConnectorImapConnection(Guid, int)

Get an inbox connector IMAP connection

Declaration

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

Remarks

Get IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorImapConnectionWithHttpInfo(Guid, int)

Get an inbox connector IMAP connection

Declaration

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

Remarks

Get IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorProviderSettings(int)

Get SMTP and IMAP connection settings for common mail providers

Declaration

ConnectorProviderSettingsDto GetConnectorProviderSettings(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConnectorProviderSettingsDto	ConnectorProviderSettingsDto

Remarks

Get common mail provider SMTP and IMAP connection settings

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorProviderSettingsWithHttpInfo(int)

Get SMTP and IMAP connection settings for common mail providers

Declaration

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

Remarks

Get common mail provider SMTP and IMAP connection settings

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSmtpConnection(Guid, int)

Get an inbox connector SMTP connection

Declaration

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

Remarks

Get SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSmtpConnectionWithHttpInfo(Guid, int)

Get an inbox connector SMTP connection

Declaration

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

Remarks

Get SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSyncSettings(Guid, int)

Get an inbox connector sync settings

Declaration

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

Remarks

Get sync settings for connection with external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetConnectorSyncSettingsWithHttpInfo(Guid, int)

Get an inbox connector sync settings

Declaration

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

Remarks

Get sync settings for connection with external inbox

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

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

SendEmailFromConnector(Guid, SendEmailOptions, bool?, int)

Send from an inbox connector

Declaration

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

View Source

SendEmailFromConnectorWithHttpInfo(Guid, SendEmailOptions, bool?, int)

Send from an inbox connector

Declaration

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

View Source

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

Sync an inbox connector

Declaration

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

View Source

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

Sync an inbox connector

Declaration

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

View Source

TestConnectorImapConnection(Guid, CreateConnectorImapConnectionOptions, int)

Test an inbox connector IMAP connection

Declaration

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

Remarks

Test the IMAP connection for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorImapConnectionOptions(CreateConnectorImapConnectionOptions, int)

Test an inbox connector IMAP connection options

Declaration

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

Remarks

Test the IMAP connection options for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorImapConnectionOptionsWithHttpInfo(CreateConnectorImapConnectionOptions, int)

Test an inbox connector IMAP connection options

Declaration

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

Remarks

Test the IMAP connection options for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorImapConnectionWithHttpInfo(Guid, CreateConnectorImapConnectionOptions, int)

Test an inbox connector IMAP connection

Declaration

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

Remarks

Test the IMAP connection for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorSmtpConnection(Guid, CreateConnectorSmtpConnectionOptions, int)

Test an inbox connector SMTP connection

Declaration

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

Remarks

Test the SMTP connection for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorSmtpConnectionOptions(CreateConnectorSmtpConnectionOptions, int)

Test an inbox connector SMTP connection options

Declaration

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

Remarks

Test the SMTP connection options for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorSmtpConnectionOptionsWithHttpInfo(CreateConnectorSmtpConnectionOptions, int)

Test an inbox connector SMTP connection options

Declaration

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

Remarks

Test the SMTP connection options for a connector

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestConnectorSmtpConnectionWithHttpInfo(Guid, CreateConnectorSmtpConnectionOptions, int)

Test an inbox connector SMTP connection

Declaration

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

Remarks

Test the SMTP connection for a connector

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

UpdateConnectorImapConnection(Guid, CreateConnectorImapConnectionOptions, int)

Update an inbox connector IMAP connection

Declaration

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

Remarks

Update IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorImapConnectionWithHttpInfo(Guid, CreateConnectorImapConnectionOptions, int)

Update an inbox connector IMAP connection

Declaration

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

Remarks

Update IMAP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorSmtpConnection(Guid, CreateConnectorSmtpConnectionOptions, int)

Update an inbox connector SMTP connection

Declaration

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

Remarks

Update SMTP connection for external inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateConnectorSmtpConnectionWithHttpInfo(Guid, CreateConnectorSmtpConnectionOptions, int)

Update an inbox connector SMTP connection

Declaration

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

Remarks

Update SMTP connection for external inbox

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