Interface IInboxForwarderControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

IApiAccessor.ExceptionFactory

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IInboxForwarderControllerApiSync : IApiAccessor

Methods

CreateNewInboxForwarder(CreateInboxForwarderOptions, Guid?, int)

Create an inbox forwarder

Declaration

InboxForwarderDto CreateNewInboxForwarder(CreateInboxForwarderOptions createInboxForwarderOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
CreateInboxForwarderOptions	createInboxForwarderOptions
Guid?	inboxId	Inbox id to attach forwarder to (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxForwarderDto	InboxForwarderDto

Remarks

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateNewInboxForwarderWithHttpInfo(CreateInboxForwarderOptions, Guid?, int)

Create an inbox forwarder

Declaration

ApiResponse<InboxForwarderDto> CreateNewInboxForwarderWithHttpInfo(CreateInboxForwarderOptions createInboxForwarderOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
CreateInboxForwarderOptions	createInboxForwarderOptions
Guid?	inboxId	Inbox id to attach forwarder to (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxForwarderDto>	ApiResponse of InboxForwarderDto

Remarks

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxForwarder(Guid, int)

Delete an inbox forwarder

Declaration

void DeleteInboxForwarder(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
int	operationIndex	Index associated with the operation.

Remarks

Delete inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxForwarderWithHttpInfo(Guid, int)

Delete an inbox forwarder

Declaration

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

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
int	operationIndex	Index associated with the operation.

Returns

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

Remarks

Delete inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxForwarders(Guid?, int)

Delete inbox forwarders

Declaration

void DeleteInboxForwarders(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	Optional inbox id to attach forwarder to (optional)
int	operationIndex	Index associated with the operation.

Remarks

Delete inbox forwarders. Accepts optional inboxId filter.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxForwardersWithHttpInfo(Guid?, int)

Delete inbox forwarders

Declaration

ApiResponse<object> DeleteInboxForwardersWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	Optional inbox id to attach forwarder to (optional)
int	operationIndex	Index associated with the operation.

Returns

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

Remarks

Delete inbox forwarders. Accepts optional inboxId filter.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllInboxForwarderEvents(int?, int?, Guid?, Guid?, Guid?, string, int)

Get all inbox forwarder events

Declaration

PageInboxForwarderEvents GetAllInboxForwarderEvents(int? page = null, int? size = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentId = null, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in inbox forwarder event list pagination (optional, default to 0)
int?	size	Optional page size in inbox forwarder event list pagination (optional, default to 20)
Guid?	inboxId	Optional inbox ID to filter for (optional)
Guid?	emailId	Optional email ID to filter for (optional)
Guid?	sentId	Optional sent ID to filter for (optional)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageInboxForwarderEvents	PageInboxForwarderEvents

Remarks

Get all inbox forwarder events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllInboxForwarderEventsWithHttpInfo(int?, int?, Guid?, Guid?, Guid?, string, int)

Get all inbox forwarder events

Declaration

ApiResponse<PageInboxForwarderEvents> GetAllInboxForwarderEventsWithHttpInfo(int? page = null, int? size = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentId = null, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index in inbox forwarder event list pagination (optional, default to 0)
int?	size	Optional page size in inbox forwarder event list pagination (optional, default to 20)
Guid?	inboxId	Optional inbox ID to filter for (optional)
Guid?	emailId	Optional email ID to filter for (optional)
Guid?	sentId	Optional sent ID to filter for (optional)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageInboxForwarderEvents>	ApiResponse of PageInboxForwarderEvents

Remarks

Get all inbox forwarder events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetForwarderEvent(Guid, int)

Get a forwarder event

Declaration

InboxForwarderEventDto GetForwarderEvent(Guid eventId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	eventId	ID of inbox forwarder event
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxForwarderEventDto	InboxForwarderEventDto

Remarks

Get forwarder event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetForwarderEventWithHttpInfo(Guid, int)

Get a forwarder event

Declaration

ApiResponse<InboxForwarderEventDto> GetForwarderEventWithHttpInfo(Guid eventId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	eventId	ID of inbox forwarder event
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxForwarderEventDto>	ApiResponse of InboxForwarderEventDto

Remarks

Get forwarder event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarder(Guid, int)

Get an inbox forwarder

Declaration

InboxForwarderDto GetInboxForwarder(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxForwarderDto	InboxForwarderDto

Remarks

Get inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderEvent(Guid, Guid, int)

Get an inbox forwarder event

Declaration

InboxForwarderEventDto GetInboxForwarderEvent(Guid id, Guid eventId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
Guid	eventId	ID of inbox forwarder event
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxForwarderEventDto	InboxForwarderEventDto

Remarks

Get inbox forwarder event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderEventWithHttpInfo(Guid, Guid, int)

Get an inbox forwarder event

Declaration

ApiResponse<InboxForwarderEventDto> GetInboxForwarderEventWithHttpInfo(Guid id, Guid eventId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
Guid	eventId	ID of inbox forwarder event
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxForwarderEventDto>	ApiResponse of InboxForwarderEventDto

Remarks

Get inbox forwarder event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderEvents(Guid, int?, int?, string, int)

Get an inbox forwarder event list

Declaration

PageInboxForwarderEvents GetInboxForwarderEvents(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
int?	page	Optional page index in inbox forwarder event list pagination (optional, default to 0)
int?	size	Optional page size in inbox forwarder event list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageInboxForwarderEvents	PageInboxForwarderEvents

Remarks

Get inbox forwarder events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderEventsWithHttpInfo(Guid, int?, int?, string, int)

Get an inbox forwarder event list

Declaration

ApiResponse<PageInboxForwarderEvents> GetInboxForwarderEventsWithHttpInfo(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
int?	page	Optional page index in inbox forwarder event list pagination (optional, default to 0)
int?	size	Optional page size in inbox forwarder event list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageInboxForwarderEvents>	ApiResponse of PageInboxForwarderEvents

Remarks

Get inbox forwarder events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderWithHttpInfo(Guid, int)

Get an inbox forwarder

Declaration

ApiResponse<InboxForwarderDto> GetInboxForwarderWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxForwarderDto>	ApiResponse of InboxForwarderDto

Remarks

Get inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox forwarders

Declaration

PageInboxForwarderDto GetInboxForwarders(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	Optional inbox id to get forwarders from (optional)
int?	page	Optional page index in inbox forwarder list pagination (optional, default to 0)
int?	size	Optional page size in inbox forwarder list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
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
PageInboxForwarderDto	PageInboxForwarderDto

Remarks

List all forwarders attached to an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox forwarders

Declaration

ApiResponse<PageInboxForwarderDto> GetInboxForwardersWithHttpInfo(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	Optional inbox id to get forwarders from (optional)
int?	page	Optional page index in inbox forwarder list pagination (optional, default to 0)
int?	size	Optional page size in inbox forwarder list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	searchFilter	Optional search filter (optional)
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<PageInboxForwarderDto>	ApiResponse of PageInboxForwarderDto

Remarks

List all forwarders attached to an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxForwarder(Guid, InboxForwarderTestOptions, int)

Test an inbox forwarder

Declaration

InboxForwarderTestResult TestInboxForwarder(Guid id, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
InboxForwarderTestOptions	inboxForwarderTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxForwarderTestResult	InboxForwarderTestResult

Remarks

Test an inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxForwarderWithHttpInfo(Guid, InboxForwarderTestOptions, int)

Test an inbox forwarder

Declaration

ApiResponse<InboxForwarderTestResult> TestInboxForwarderWithHttpInfo(Guid id, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
InboxForwarderTestOptions	inboxForwarderTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxForwarderTestResult>	ApiResponse of InboxForwarderTestResult

Remarks

Test an inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxForwardersForInbox(Guid, InboxForwarderTestOptions, int)

Test inbox forwarders for inbox

Declaration

InboxForwarderTestResult TestInboxForwardersForInbox(Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox
InboxForwarderTestOptions	inboxForwarderTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxForwarderTestResult	InboxForwarderTestResult

Remarks

Test inbox forwarders for inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxForwardersForInboxWithHttpInfo(Guid, InboxForwarderTestOptions, int)

Test inbox forwarders for inbox

Declaration

ApiResponse<InboxForwarderTestResult> TestInboxForwardersForInboxWithHttpInfo(Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox
InboxForwarderTestOptions	inboxForwarderTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxForwarderTestResult>	ApiResponse of InboxForwarderTestResult

Remarks

Test inbox forwarders for inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestNewInboxForwarder(TestNewInboxForwarderOptions, int)

Test new inbox forwarder

Declaration

InboxForwarderTestResult TestNewInboxForwarder(TestNewInboxForwarderOptions testNewInboxForwarderOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestNewInboxForwarderOptions	testNewInboxForwarderOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxForwarderTestResult	InboxForwarderTestResult

Remarks

Test new inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestNewInboxForwarderWithHttpInfo(TestNewInboxForwarderOptions, int)

Test new inbox forwarder

Declaration

ApiResponse<InboxForwarderTestResult> TestNewInboxForwarderWithHttpInfo(TestNewInboxForwarderOptions testNewInboxForwarderOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestNewInboxForwarderOptions	testNewInboxForwarderOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxForwarderTestResult>	ApiResponse of InboxForwarderTestResult

Remarks

Test new inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateInboxForwarder(Guid, CreateInboxForwarderOptions, int)

Update an inbox forwarder

Declaration

InboxForwarderDto UpdateInboxForwarder(Guid id, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
CreateInboxForwarderOptions	createInboxForwarderOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxForwarderDto	InboxForwarderDto

Remarks

Update inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateInboxForwarderWithHttpInfo(Guid, CreateInboxForwarderOptions, int)

Update an inbox forwarder

Declaration

ApiResponse<InboxForwarderDto> UpdateInboxForwarderWithHttpInfo(Guid id, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of inbox forwarder
CreateInboxForwarderOptions	createInboxForwarderOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxForwarderDto>	ApiResponse of InboxForwarderDto

Remarks

Update inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call