Class RulesetControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

RulesetControllerApi

Implements

IRulesetControllerApi

IRulesetControllerApiSync

IRulesetControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class RulesetControllerApi : IRulesetControllerApi, IRulesetControllerApiSync, IRulesetControllerApiAsync, IApiAccessor

Constructors

View Source

RulesetControllerApi()

Initializes a new instance of the RulesetControllerApi class.

Declaration

public RulesetControllerApi()

View Source

RulesetControllerApi(string)

Initializes a new instance of the RulesetControllerApi class.

Declaration

public RulesetControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

RulesetControllerApi(Configuration)

Initializes a new instance of the RulesetControllerApi class using Configuration object

Declaration

public RulesetControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

RulesetControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the RulesetControllerApi class using a Configuration object and client instance.

Declaration

public RulesetControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRuleset(Guid, int)

Delete a ruleset Delete ruleset

Declaration

public void DeleteRuleset(Guid id, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetAsync(Guid, int, CancellationToken)

Delete a ruleset Delete ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetWithHttpInfo(Guid, int)

Delete a ruleset Delete ruleset

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a ruleset Delete ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesets(Guid?, Guid?, int)

Delete rulesets Delete rulesets. Accepts optional inboxId or phoneId filters.

Declaration

public 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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Delete rulesets Delete rulesets. Accepts optional inboxId or phoneId filters.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteRulesetsWithHttpInfo(Guid?, Guid?, int)

Delete rulesets Delete rulesets. Accepts optional inboxId or phoneId filters.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Delete rulesets Delete rulesets. Accepts optional inboxId or phoneId filters.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetRuleset(Guid, int)

Get a ruleset Get ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetRulesetAsync(Guid, int, CancellationToken)

Get a ruleset Get ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetRulesetWithHttpInfo(Guid, int)

Get a ruleset Get ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetRulesetWithHttpInfoAsync(Guid, int, CancellationToken)

Get a ruleset Get ruleset

Declaration

public 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)

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 List all rulesets attached to an inbox or phone or account

Declaration

public 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

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 List all rulesets attached to an inbox or phone or account

Declaration

public 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

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 List all rulesets attached to an inbox or phone or account

Declaration

public 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

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 List all rulesets attached to an inbox or phone or account

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestInboxRulesetsForInbox(Guid, RulesetTestOptions, int)

Test inbox rulesets for inbox Test inbox rulesets for inbox

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestInboxRulesetsForInboxAsync(Guid, RulesetTestOptions, int, CancellationToken)

Test inbox rulesets for inbox Test inbox rulesets for inbox

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestInboxRulesetsForInboxWithHttpInfo(Guid, RulesetTestOptions, int)

Test inbox rulesets for inbox Test inbox rulesets for inbox

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestInboxRulesetsForInboxWithHttpInfoAsync(Guid, RulesetTestOptions, int, CancellationToken)

Test inbox rulesets for inbox Test inbox rulesets for inbox

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestNewRuleset(TestNewInboxRulesetOptions, int)

Test new ruleset Test new ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestNewRulesetAsync(TestNewInboxRulesetOptions, int, CancellationToken)

Test new ruleset Test new ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestNewRulesetWithHttpInfo(TestNewInboxRulesetOptions, int)

Test new ruleset Test new ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestNewRulesetWithHttpInfoAsync(TestNewInboxRulesetOptions, int, CancellationToken)

Test new ruleset Test new ruleset

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRuleset(Guid, RulesetTestOptions, int)

Test a ruleset Test an inbox or phone ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetAsync(Guid, RulesetTestOptions, int, CancellationToken)

Test a ruleset Test an inbox or phone ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetReceiving(TestRulesetReceivingOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetReceivingAsync(TestRulesetReceivingOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetReceivingWithHttpInfo(TestRulesetReceivingOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetReceivingWithHttpInfoAsync(TestRulesetReceivingOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetSending(TestInboxRulesetSendingOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetSendingAsync(TestInboxRulesetSendingOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetSendingWithHttpInfoAsync(TestInboxRulesetSendingOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetWithHttpInfo(Guid, RulesetTestOptions, int)

Test a ruleset Test an inbox or phone ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestRulesetWithHttpInfoAsync(Guid, RulesetTestOptions, int, CancellationToken)

Test a ruleset Test an inbox or phone ruleset

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IRulesetControllerApi

IRulesetControllerApiSync

IRulesetControllerApiAsync

IApiAccessor