Interface IRulesetControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IRulesetControllerApiAsync : IApiAccessor

Methods

View Source

CreateNewRulesetAsync(CreateRulesetOptions, Guid?, Guid?, int, CancellationToken)

Create a ruleset

Declaration

Task<RulesetDto> CreateNewRulesetAsync(CreateRulesetOptions createRulesetOptions, Guid? inboxId = null, Guid? phoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateRulesetOptions	createRulesetOptions
Guid?	inboxId	Inbox id to attach ruleset to (optional)
Guid?	phoneId	Phone 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<RulesetDto>	Task of RulesetDto

Remarks

Create a new inbox or phone number rule for forwarding, blocking, and allowing emails or SMS when sending and receiving

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewRulesetWithHttpInfoAsync(CreateRulesetOptions, Guid?, Guid?, int, CancellationToken)

Create a ruleset

Declaration

Task<ApiResponse<RulesetDto>> CreateNewRulesetWithHttpInfoAsync(CreateRulesetOptions createRulesetOptions, Guid? inboxId = null, Guid? phoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateRulesetOptions	createRulesetOptions
Guid?	inboxId	Inbox id to attach ruleset to (optional)
Guid?	phoneId	Phone 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<RulesetDto>>	Task of ApiResponse (RulesetDto)

Remarks

Create a new inbox or phone number rule for forwarding, blocking, and allowing emails or SMS when sending and receiving

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetAsync(Guid, int, CancellationToken)

Delete a ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetsAsync(Guid?, Guid?, int, CancellationToken)

Delete rulesets

Declaration

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

Parameters

Type	Name	Description
Guid?	inboxId	Optional inbox id to attach ruleset to (optional)
Guid?	phoneId	(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 rulesets. Accepts optional inboxId or phoneId filters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetsWithHttpInfoAsync(Guid?, Guid?, int, CancellationToken)

Delete rulesets

Declaration

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

Parameters

Type	Name	Description
Guid?	inboxId	Optional inbox id to attach ruleset to (optional)
Guid?	phoneId	(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 rulesets. Accepts optional inboxId or phoneId filters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetRulesetAsync(Guid, int, CancellationToken)

Get a ruleset

Declaration

Task<RulesetDto> GetRulesetAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<RulesetDto>	Task of RulesetDto

Remarks

Get ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetRulesetWithHttpInfoAsync(Guid, int, CancellationToken)

Get a ruleset

Declaration

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

Parameters

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

Returns

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

Remarks

Get ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List rulesets block and allow lists

Declaration

Task<PageRulesetDto> GetRulesetsAsync(Guid? inboxId = null, Guid? phoneId = 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
Guid?	inboxId	Optional inbox id to get rulesets from (optional)
Guid?	phoneId	Optional phone 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<PageRulesetDto>	Task of PageRulesetDto

Remarks

List all rulesets attached to an inbox or phone or account

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List rulesets block and allow lists

Declaration

Task<ApiResponse<PageRulesetDto>> GetRulesetsWithHttpInfoAsync(Guid? inboxId = null, Guid? phoneId = 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
Guid?	inboxId	Optional inbox id to get rulesets from (optional)
Guid?	phoneId	Optional phone 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<PageRulesetDto>>	Task of ApiResponse (PageRulesetDto)

Remarks

List all rulesets attached to an inbox or phone or account

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestInboxRulesetsForInboxAsync(Guid, RulesetTestOptions, int, CancellationToken)

Test inbox rulesets for inbox

Declaration

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

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox
RulesetTestOptions	rulesetTestOptions
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

View Source

TestInboxRulesetsForInboxWithHttpInfoAsync(Guid, RulesetTestOptions, int, CancellationToken)

Test inbox rulesets for inbox

Declaration

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

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox
RulesetTestOptions	rulesetTestOptions
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

View Source

TestNewRulesetAsync(TestNewInboxRulesetOptions, int, CancellationToken)

Test new ruleset

Declaration

Task<InboxRulesetTestResult> TestNewRulesetAsync(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 ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestNewRulesetWithHttpInfoAsync(TestNewInboxRulesetOptions, int, CancellationToken)

Test new ruleset

Declaration

Task<ApiResponse<InboxRulesetTestResult>> TestNewRulesetWithHttpInfoAsync(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 ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetAsync(Guid, RulesetTestOptions, int, CancellationToken)

Test a ruleset

Declaration

Task<InboxRulesetTestResult> TestRulesetAsync(Guid id, RulesetTestOptions rulesetTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id	ID of ruleset
RulesetTestOptions	rulesetTestOptions
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 or phone ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetReceivingAsync(TestRulesetReceivingOptions, int, CancellationToken)

Test receiving with rulesets

Declaration

Task<TestRulesetReceivingResult> TestRulesetReceivingAsync(TestRulesetReceivingOptions testRulesetReceivingOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<TestRulesetReceivingResult>	Task of TestRulesetReceivingResult

Remarks

Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets or test if phone number can receive SMS

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetReceivingWithHttpInfoAsync(TestRulesetReceivingOptions, int, CancellationToken)

Test receiving with rulesets

Declaration

Task<ApiResponse<TestRulesetReceivingResult>> TestRulesetReceivingWithHttpInfoAsync(TestRulesetReceivingOptions testRulesetReceivingOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets or test if phone number can receive SMS

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetSendingAsync(TestInboxRulesetSendingOptions, int, CancellationToken)

Test sending with rulesets

Declaration

Task<TestRulesetSendingResult> TestRulesetSendingAsync(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<TestRulesetSendingResult>	Task of TestRulesetSendingResult

Remarks

Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets or whether a phone number can send SMS

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetSendingWithHttpInfoAsync(TestInboxRulesetSendingOptions, int, CancellationToken)

Test sending with rulesets

Declaration

Task<ApiResponse<TestRulesetSendingResult>> TestRulesetSendingWithHttpInfoAsync(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<TestRulesetSendingResult>>	Task of ApiResponse (TestRulesetSendingResult)

Remarks

Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets or whether a phone number can send SMS

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetWithHttpInfoAsync(Guid, RulesetTestOptions, int, CancellationToken)

Test a ruleset

Declaration

Task<ApiResponse<InboxRulesetTestResult>> TestRulesetWithHttpInfoAsync(Guid id, RulesetTestOptions rulesetTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id	ID of ruleset
RulesetTestOptions	rulesetTestOptions
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 or phone ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call