Interface IInboxForwarderControllerApiAsync

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 IInboxForwarderControllerApiAsync : IApiAccessor

Methods

CreateNewInboxForwarderAsync(Guid, CreateInboxForwarderOptions, int, CancellationToken)

Create an inbox forwarder

Declaration

Task<InboxForwarderDto> CreateNewInboxForwarderAsync(Guid inboxId, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	Inbox id to attach forwarder to
CreateInboxForwarderOptions	createInboxForwarderOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxForwarderDto>	Task 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

CreateNewInboxForwarderWithHttpInfoAsync(Guid, CreateInboxForwarderOptions, int, CancellationToken)

Create an inbox forwarder

Declaration

Task<ApiResponse<InboxForwarderDto>> CreateNewInboxForwarderWithHttpInfoAsync(Guid inboxId, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	Inbox id to attach forwarder to
CreateInboxForwarderOptions	createInboxForwarderOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<InboxForwarderDto>>	Task of ApiResponse (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

DeleteInboxForwarderAsync(Guid, int, CancellationToken)

Delete an inbox forwarder

Declaration

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

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxForwardersAsync(Guid?, int, CancellationToken)

Delete inbox forwarders

Declaration

Task DeleteInboxForwardersAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to attach forwarder to (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Remarks

Delete inbox forwarders. Accepts optional inboxId filter.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxForwardersWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete inbox forwarders

Declaration

Task<ApiResponse<object>> DeleteInboxForwardersWithHttpInfoAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to attach forwarder to (optional)
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 inbox forwarders. Accepts optional inboxId filter.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxForwarderWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox forwarder

Declaration

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

Parameters

Type	Name	Description
System.Guid	id	ID of inbox forwarder
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 inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllInboxForwarderEventsAsync(int?, int?, Guid?, string, int, CancellationToken)

Get all inbox forwarder events

Declaration

Task<PageInboxForwarderEvents> GetAllInboxForwarderEventsAsync(int? page = null, int? size = null, Guid? inboxId = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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)
System.Guid?	inboxId	Optional inbox 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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageInboxForwarderEvents>	Task of PageInboxForwarderEvents

Remarks

Get all inbox forwarder events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllInboxForwarderEventsWithHttpInfoAsync(int?, int?, Guid?, string, int, CancellationToken)

Get all inbox forwarder events

Declaration

Task<ApiResponse<PageInboxForwarderEvents>> GetAllInboxForwarderEventsWithHttpInfoAsync(int? page = null, int? size = null, Guid? inboxId = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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)
System.Guid?	inboxId	Optional inbox 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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get all inbox forwarder events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetForwarderEventAsync(Guid, int, CancellationToken)

Get a forwarder event

Declaration

Task<InboxForwarderEventDto> GetForwarderEventAsync(Guid eventId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	eventId	ID of inbox forwarder event
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxForwarderEventDto>	Task of InboxForwarderEventDto

Remarks

Get forwarder event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetForwarderEventWithHttpInfoAsync(Guid, int, CancellationToken)

Get a forwarder event

Declaration

Task<ApiResponse<InboxForwarderEventDto>> GetForwarderEventWithHttpInfoAsync(Guid eventId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	eventId	ID of inbox forwarder event
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get forwarder event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderAsync(Guid, int, CancellationToken)

Get an inbox forwarder

Declaration

Task<InboxForwarderDto> GetInboxForwarderAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxForwarderDto>	Task of InboxForwarderDto

Remarks

Get inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderEventAsync(Guid, Guid, int, CancellationToken)

Get an inbox forwarder event

Declaration

Task<InboxForwarderEventDto> GetInboxForwarderEventAsync(Guid id, Guid eventId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox forwarder
System.Guid	eventId	ID of inbox forwarder event
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxForwarderEventDto>	Task of InboxForwarderEventDto

Remarks

Get inbox forwarder event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderEventsAsync(Guid, int?, int?, string, int, CancellationToken)

Get an inbox forwarder event list

Declaration

Task<PageInboxForwarderEvents> GetInboxForwarderEventsAsync(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageInboxForwarderEvents>	Task of PageInboxForwarderEvents

Remarks

Get inbox forwarder events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderEventsWithHttpInfoAsync(Guid, int?, int?, string, int, CancellationToken)

Get an inbox forwarder event list

Declaration

Task<ApiResponse<PageInboxForwarderEvents>> GetInboxForwarderEventsWithHttpInfoAsync(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get inbox forwarder events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderEventWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Get an inbox forwarder event

Declaration

Task<ApiResponse<InboxForwarderEventDto>> GetInboxForwarderEventWithHttpInfoAsync(Guid id, Guid eventId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox forwarder
System.Guid	eventId	ID of inbox forwarder event
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get inbox forwarder event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox forwarders

Declaration

Task<PageInboxForwarderDto> GetInboxForwardersAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageInboxForwarderDto>	Task of PageInboxForwarderDto

Remarks

List all forwarders attached to an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox forwarders

Declaration

Task<ApiResponse<PageInboxForwarderDto>> GetInboxForwardersWithHttpInfoAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

List all forwarders attached to an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxForwarderWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox forwarder

Declaration

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

Parameters

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

Returns

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

Remarks

Get inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxForwarderAsync(Guid, InboxForwarderTestOptions, int, CancellationToken)

Test an inbox forwarder

Declaration

Task<InboxForwarderTestResult> TestInboxForwarderAsync(Guid id, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox forwarder
InboxForwarderTestOptions	inboxForwarderTestOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxForwarderTestResult>	Task of InboxForwarderTestResult

Remarks

Test an inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxForwardersForInboxAsync(Guid, InboxForwarderTestOptions, int, CancellationToken)

Test inbox forwarders for inbox

Declaration

Task<InboxForwarderTestResult> TestInboxForwardersForInboxAsync(Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of inbox
InboxForwarderTestOptions	inboxForwarderTestOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxForwarderTestResult>	Task of InboxForwarderTestResult

Remarks

Test inbox forwarders for inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxForwardersForInboxWithHttpInfoAsync(Guid, InboxForwarderTestOptions, int, CancellationToken)

Test inbox forwarders for inbox

Declaration

Task<ApiResponse<InboxForwarderTestResult>> TestInboxForwardersForInboxWithHttpInfoAsync(Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId	ID of inbox
InboxForwarderTestOptions	inboxForwarderTestOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Test inbox forwarders for inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxForwarderWithHttpInfoAsync(Guid, InboxForwarderTestOptions, int, CancellationToken)

Test an inbox forwarder

Declaration

Task<ApiResponse<InboxForwarderTestResult>> TestInboxForwarderWithHttpInfoAsync(Guid id, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox forwarder
InboxForwarderTestOptions	inboxForwarderTestOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Test an inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestNewInboxForwarderAsync(TestNewInboxForwarderOptions, int, CancellationToken)

Test new inbox forwarder

Declaration

Task<InboxForwarderTestResult> TestNewInboxForwarderAsync(TestNewInboxForwarderOptions testNewInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxForwarderTestResult>	Task of InboxForwarderTestResult

Remarks

Test new inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestNewInboxForwarderWithHttpInfoAsync(TestNewInboxForwarderOptions, int, CancellationToken)

Test new inbox forwarder

Declaration

Task<ApiResponse<InboxForwarderTestResult>> TestNewInboxForwarderWithHttpInfoAsync(TestNewInboxForwarderOptions testNewInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Test new inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateInboxForwarderAsync(Guid, CreateInboxForwarderOptions, int, CancellationToken)

Update an inbox forwarder

Declaration

Task<InboxForwarderDto> UpdateInboxForwarderAsync(Guid id, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox forwarder
CreateInboxForwarderOptions	createInboxForwarderOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxForwarderDto>	Task of InboxForwarderDto

Remarks

Update inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateInboxForwarderWithHttpInfoAsync(Guid, CreateInboxForwarderOptions, int, CancellationToken)

Update an inbox forwarder

Declaration

Task<ApiResponse<InboxForwarderDto>> UpdateInboxForwarderWithHttpInfoAsync(Guid id, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox forwarder
CreateInboxForwarderOptions	createInboxForwarderOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Update inbox forwarder

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call