Interface IRulesetControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IRulesetControllerApiSync : IApiAccessor

Methods

View Source

CreateNewRuleset(CreateRulesetOptions, Guid?, Guid?, int)

Create a ruleset

Declaration

RulesetDto CreateNewRuleset(CreateRulesetOptions createRulesetOptions, Guid? inboxId = null, Guid? phoneId = null, int operationIndex = 0)

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.

Returns

Type	Description
RulesetDto	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

CreateNewRulesetWithHttpInfo(CreateRulesetOptions, Guid?, Guid?, int)

Create a ruleset

Declaration

ApiResponse<RulesetDto> CreateNewRulesetWithHttpInfo(CreateRulesetOptions createRulesetOptions, Guid? inboxId = null, Guid? phoneId = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<RulesetDto>	ApiResponse 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

DeleteRuleset(Guid, int)

Delete a ruleset

Declaration

void DeleteRuleset(Guid id, int operationIndex = 0)

Parameters

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

Remarks

Delete ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetWithHttpInfo(Guid, int)

Delete a ruleset

Declaration

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

Parameters

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

Returns

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

Remarks

Delete ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesets(Guid?, Guid?, int)

Delete rulesets

Declaration

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

Parameters

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

Remarks

Delete rulesets. Accepts optional inboxId or phoneId filters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetsWithHttpInfo(Guid?, Guid?, int)

Delete rulesets

Declaration

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

Parameters

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

Returns

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

Remarks

Delete rulesets. Accepts optional inboxId or phoneId filters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetRuleset(Guid, int)

Get a ruleset

Declaration

RulesetDto GetRuleset(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
RulesetDto	RulesetDto

Remarks

Get ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetRulesetWithHttpInfo(Guid, int)

Get a ruleset

Declaration

ApiResponse<RulesetDto> GetRulesetWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<RulesetDto>	ApiResponse of RulesetDto

Remarks

Get ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List rulesets block and allow lists

Declaration

PageRulesetDto GetRulesets(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)

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.

Returns

Type	Description
PageRulesetDto	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

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

List rulesets block and allow lists

Declaration

ApiResponse<PageRulesetDto> GetRulesetsWithHttpInfo(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)

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.

Returns

Type	Description
ApiResponse<PageRulesetDto>	ApiResponse 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

TestInboxRulesetsForInbox(Guid, RulesetTestOptions, int)

Test inbox rulesets for inbox

Declaration

InboxRulesetTestResult TestInboxRulesetsForInbox(Guid inboxId, RulesetTestOptions rulesetTestOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
InboxRulesetTestResult	InboxRulesetTestResult

Remarks

Test inbox rulesets for inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestInboxRulesetsForInboxWithHttpInfo(Guid, RulesetTestOptions, int)

Test inbox rulesets for inbox

Declaration

ApiResponse<InboxRulesetTestResult> TestInboxRulesetsForInboxWithHttpInfo(Guid inboxId, RulesetTestOptions rulesetTestOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<InboxRulesetTestResult>	ApiResponse of InboxRulesetTestResult

Remarks

Test inbox rulesets for inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestNewRuleset(TestNewInboxRulesetOptions, int)

Test new ruleset

Declaration

InboxRulesetTestResult TestNewRuleset(TestNewInboxRulesetOptions testNewInboxRulesetOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestNewInboxRulesetOptions	testNewInboxRulesetOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxRulesetTestResult	InboxRulesetTestResult

Remarks

Test new ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestNewRulesetWithHttpInfo(TestNewInboxRulesetOptions, int)

Test new ruleset

Declaration

ApiResponse<InboxRulesetTestResult> TestNewRulesetWithHttpInfo(TestNewInboxRulesetOptions testNewInboxRulesetOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestNewInboxRulesetOptions	testNewInboxRulesetOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxRulesetTestResult>	ApiResponse of InboxRulesetTestResult

Remarks

Test new ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRuleset(Guid, RulesetTestOptions, int)

Test a ruleset

Declaration

InboxRulesetTestResult TestRuleset(Guid id, RulesetTestOptions rulesetTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of ruleset
RulesetTestOptions	rulesetTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxRulesetTestResult	InboxRulesetTestResult

Remarks

Test an inbox or phone ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetReceiving(TestRulesetReceivingOptions, int)

Test receiving with rulesets

Declaration

TestRulesetReceivingResult TestRulesetReceiving(TestRulesetReceivingOptions testRulesetReceivingOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestRulesetReceivingOptions	testRulesetReceivingOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
TestRulesetReceivingResult	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

TestRulesetReceivingWithHttpInfo(TestRulesetReceivingOptions, int)

Test receiving with rulesets

Declaration

ApiResponse<TestRulesetReceivingResult> TestRulesetReceivingWithHttpInfo(TestRulesetReceivingOptions testRulesetReceivingOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestRulesetReceivingOptions	testRulesetReceivingOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<TestRulesetReceivingResult>	ApiResponse 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

TestRulesetSending(TestInboxRulesetSendingOptions, int)

Test sending with rulesets

Declaration

TestRulesetSendingResult TestRulesetSending(TestInboxRulesetSendingOptions testInboxRulesetSendingOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestInboxRulesetSendingOptions	testInboxRulesetSendingOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
TestRulesetSendingResult	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

TestRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions, int)

Test sending with rulesets

Declaration

ApiResponse<TestRulesetSendingResult> TestRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions testInboxRulesetSendingOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestInboxRulesetSendingOptions	testInboxRulesetSendingOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<TestRulesetSendingResult>	ApiResponse 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

TestRulesetWithHttpInfo(Guid, RulesetTestOptions, int)

Test a ruleset

Declaration

ApiResponse<InboxRulesetTestResult> TestRulesetWithHttpInfo(Guid id, RulesetTestOptions rulesetTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of ruleset
RulesetTestOptions	rulesetTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxRulesetTestResult>	ApiResponse of InboxRulesetTestResult

Remarks

Test an inbox or phone ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call