Interface IInboxRulesetControllerApiAsync

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

Methods

CreateNewInboxRulesetAsync(CreateInboxRulesetOptions, Guid?, int, CancellationToken)

Create an inbox ruleset

Declaration

Task<InboxRulesetDto> CreateNewInboxRulesetAsync(CreateInboxRulesetOptions createInboxRulesetOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateInboxRulesetOptions	createInboxRulesetOptions
System.Guid?	inboxId	Inbox id to attach ruleset to (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxRulesetDto>	Task of InboxRulesetDto

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

CreateNewInboxRulesetWithHttpInfoAsync(CreateInboxRulesetOptions, Guid?, int, CancellationToken)

Create an inbox ruleset

Declaration

Task<ApiResponse<InboxRulesetDto>> CreateNewInboxRulesetWithHttpInfoAsync(CreateInboxRulesetOptions createInboxRulesetOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateInboxRulesetOptions	createInboxRulesetOptions
System.Guid?	inboxId	Inbox id to attach ruleset to (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

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

DeleteInboxRulesetAsync(Guid, int, CancellationToken)

Delete an inbox ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRulesetsAsync(Guid?, int, CancellationToken)

Delete inbox rulesets

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRulesetsWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete inbox rulesets

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRulesetWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxRulesetAsync(Guid, int, CancellationToken)

Get an inbox ruleset

Declaration

Task<InboxRulesetDto> GetInboxRulesetAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxRulesetDto>	Task of InboxRulesetDto

Remarks

Get inbox ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox rulesets

Declaration

Task<PageInboxRulesetDto> GetInboxRulesetsAsync(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 rulesets from (optional)
int?	page	Optional page index in inbox ruleset list pagination (optional, default to 0)
int?	size	Optional page size in inbox ruleset 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<PageInboxRulesetDto>	Task of PageInboxRulesetDto

Remarks

List all rulesets attached to an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox rulesets

Declaration

Task<ApiResponse<PageInboxRulesetDto>> GetInboxRulesetsWithHttpInfoAsync(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 rulesets from (optional)
int?	page	Optional page index in inbox ruleset list pagination (optional, default to 0)
int?	size	Optional page size in inbox ruleset 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<PageInboxRulesetDto>>	Task of ApiResponse (PageInboxRulesetDto)

Remarks

List all rulesets attached to an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxRulesetWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox ruleset

Declaration

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

Parameters

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

Returns

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

Remarks

Get inbox ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetAsync(Guid, InboxRulesetTestOptions, int, CancellationToken)

Test an inbox ruleset

Declaration

Task<InboxRulesetTestResult> TestInboxRulesetAsync(Guid id, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxRulesetTestResult>	Task of InboxRulesetTestResult

Remarks

Test an inbox ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetReceivingAsync(TestInboxRulesetReceivingOptions, int, CancellationToken)

Test receiving with inbox rulesets

Declaration

Task<TestInboxRulesetReceivingResult> TestInboxRulesetReceivingAsync(TestInboxRulesetReceivingOptions testInboxRulesetReceivingOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<TestInboxRulesetReceivingResult>	Task of TestInboxRulesetReceivingResult

Remarks

Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetReceivingWithHttpInfoAsync(TestInboxRulesetReceivingOptions, int, CancellationToken)

Test receiving with inbox rulesets

Declaration

Task<ApiResponse<TestInboxRulesetReceivingResult>> TestInboxRulesetReceivingWithHttpInfoAsync(TestInboxRulesetReceivingOptions testInboxRulesetReceivingOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetSendingAsync(TestInboxRulesetSendingOptions, int, CancellationToken)

Test sending with inbox rulesets

Declaration

Task<TestInboxRulesetSendingResult> TestInboxRulesetSendingAsync(TestInboxRulesetSendingOptions testInboxRulesetSendingOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<TestInboxRulesetSendingResult>	Task of TestInboxRulesetSendingResult

Remarks

Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetSendingWithHttpInfoAsync(TestInboxRulesetSendingOptions, int, CancellationToken)

Test sending with inbox rulesets

Declaration

Task<ApiResponse<TestInboxRulesetSendingResult>> TestInboxRulesetSendingWithHttpInfoAsync(TestInboxRulesetSendingOptions testInboxRulesetSendingOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetsForInboxAsync(Guid, InboxRulesetTestOptions, int, CancellationToken)

Test inbox rulesets for inbox

Declaration

Task<InboxRulesetTestResult> TestInboxRulesetsForInboxAsync(Guid inboxId, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxRulesetTestResult>	Task of InboxRulesetTestResult

Remarks

Test inbox rulesets for inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetsForInboxWithHttpInfoAsync(Guid, InboxRulesetTestOptions, int, CancellationToken)

Test inbox rulesets for inbox

Declaration

Task<ApiResponse<InboxRulesetTestResult>> TestInboxRulesetsForInboxWithHttpInfoAsync(Guid inboxId, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Test inbox rulesets for inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetWithHttpInfoAsync(Guid, InboxRulesetTestOptions, int, CancellationToken)

Test an inbox ruleset

Declaration

Task<ApiResponse<InboxRulesetTestResult>> TestInboxRulesetWithHttpInfoAsync(Guid id, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Test an inbox ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestNewInboxRulesetAsync(TestNewInboxRulesetOptions, int, CancellationToken)

Test new inbox ruleset

Declaration

Task<InboxRulesetTestResult> TestNewInboxRulesetAsync(TestNewInboxRulesetOptions testNewInboxRulesetOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxRulesetTestResult>	Task of InboxRulesetTestResult

Remarks

Test new inbox ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestNewInboxRulesetWithHttpInfoAsync(TestNewInboxRulesetOptions, int, CancellationToken)

Test new inbox ruleset

Declaration

Task<ApiResponse<InboxRulesetTestResult>> TestNewInboxRulesetWithHttpInfoAsync(TestNewInboxRulesetOptions testNewInboxRulesetOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Test new inbox ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call