Class InboxRulesetControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

InboxRulesetControllerApi

Implements

IInboxRulesetControllerApi

IInboxRulesetControllerApiSync

IInboxRulesetControllerApiAsync

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 InboxRulesetControllerApi : IInboxRulesetControllerApi, IInboxRulesetControllerApiSync, IInboxRulesetControllerApiAsync, IApiAccessor

Constructors

InboxRulesetControllerApi()

Initializes a new instance of the InboxRulesetControllerApi class.

Declaration

public InboxRulesetControllerApi()

InboxRulesetControllerApi(string)

Initializes a new instance of the InboxRulesetControllerApi class.

Declaration

public InboxRulesetControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

InboxRulesetControllerApi(Configuration)

Initializes a new instance of the InboxRulesetControllerApi class using Configuration object

Declaration

public InboxRulesetControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

InboxRulesetControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

public InboxRulesetControllerApi(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

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

CreateNewInboxRuleset(CreateInboxRulesetOptions, Guid?, int)

Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration

public InboxRulesetDto CreateNewInboxRuleset(CreateInboxRulesetOptions createInboxRulesetOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
CreateInboxRulesetOptions	createInboxRulesetOptions
Guid?	inboxId	Inbox id to attach ruleset to (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxRulesetDto	InboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateNewInboxRulesetAsync(CreateInboxRulesetOptions, Guid?, int, CancellationToken)

Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration

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

Parameters

Type	Name	Description
CreateInboxRulesetOptions	createInboxRulesetOptions
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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateNewInboxRulesetWithHttpInfo(CreateInboxRulesetOptions, Guid?, int)

Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration

public ApiResponse<InboxRulesetDto> CreateNewInboxRulesetWithHttpInfo(CreateInboxRulesetOptions createInboxRulesetOptions, Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
CreateInboxRulesetOptions	createInboxRulesetOptions
Guid?	inboxId	Inbox id to attach ruleset to (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxRulesetDto>	ApiResponse of InboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateNewInboxRulesetWithHttpInfoAsync(CreateInboxRulesetOptions, Guid?, int, CancellationToken)

Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration

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

Parameters

Type	Name	Description
CreateInboxRulesetOptions	createInboxRulesetOptions
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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRuleset(Guid, int)

Delete an inbox ruleset Delete inbox ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRulesetAsync(Guid, int, CancellationToken)

Delete an inbox ruleset Delete inbox ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRulesetWithHttpInfo(Guid, int)

Delete an inbox ruleset Delete inbox ruleset

Declaration

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

Parameters

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

DeleteInboxRulesetWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox ruleset Delete inbox ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRulesets(Guid?, int)

Delete inbox rulesets Delete inbox rulesets. Accepts optional inboxId filter.

Declaration

public void DeleteInboxRulesets(Guid? inboxId = null, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRulesetsAsync(Guid?, int, CancellationToken)

Delete inbox rulesets Delete inbox rulesets. Accepts optional inboxId filter.

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteInboxRulesetsWithHttpInfo(Guid?, int)

Delete inbox rulesets Delete inbox rulesets. Accepts optional inboxId filter.

Declaration

public ApiResponse<object> DeleteInboxRulesetsWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	inboxId	Optional inbox id to attach ruleset to (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

DeleteInboxRulesetsWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete inbox rulesets Delete inbox rulesets. Accepts optional inboxId filter.

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetInboxRuleset(Guid, int)

Get an inbox ruleset Get inbox ruleset

Declaration

public InboxRulesetDto GetInboxRuleset(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
InboxRulesetDto	InboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxRulesetAsync(Guid, int, CancellationToken)

Get an inbox ruleset Get inbox ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxRulesetWithHttpInfo(Guid, int)

Get an inbox ruleset Get inbox ruleset

Declaration

public ApiResponse<InboxRulesetDto> GetInboxRulesetWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<InboxRulesetDto>	ApiResponse of InboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetInboxRulesetWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox ruleset Get inbox ruleset

Declaration

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

Parameters

Type	Name	Description
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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox rulesets List all rulesets attached to an inbox

Declaration

public PageInboxRulesetDto GetInboxRulesets(Guid? inboxId = 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)
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
PageInboxRulesetDto	PageInboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox rulesets List all rulesets attached to an inbox

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox rulesets List all rulesets attached to an inbox

Declaration

public ApiResponse<PageInboxRulesetDto> GetInboxRulesetsWithHttpInfo(Guid? inboxId = 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)
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<PageInboxRulesetDto>	ApiResponse of PageInboxRulesetDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List inbox rulesets List all rulesets attached to an inbox

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRuleset(Guid, InboxRulesetTestOptions, int)

Test an inbox ruleset Test an inbox ruleset

Declaration

public InboxRulesetTestResult TestInboxRuleset(Guid id, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
InboxRulesetTestResult	InboxRulesetTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetAsync(Guid, InboxRulesetTestOptions, int, CancellationToken)

Test an inbox ruleset Test an inbox ruleset

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetReceiving(TestInboxRulesetReceivingOptions, int)

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

Declaration

public TestInboxRulesetReceivingResult TestInboxRulesetReceiving(TestInboxRulesetReceivingOptions testInboxRulesetReceivingOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestInboxRulesetReceivingOptions	testInboxRulesetReceivingOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
TestInboxRulesetReceivingResult	TestInboxRulesetReceivingResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetReceivingAsync(TestInboxRulesetReceivingOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetReceivingWithHttpInfo(TestInboxRulesetReceivingOptions, int)

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

Declaration

public ApiResponse<TestInboxRulesetReceivingResult> TestInboxRulesetReceivingWithHttpInfo(TestInboxRulesetReceivingOptions testInboxRulesetReceivingOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestInboxRulesetReceivingOptions	testInboxRulesetReceivingOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<TestInboxRulesetReceivingResult>	ApiResponse of TestInboxRulesetReceivingResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetReceivingWithHttpInfoAsync(TestInboxRulesetReceivingOptions, int, CancellationToken)

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

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetSending(TestInboxRulesetSendingOptions, int)

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

Declaration

public TestInboxRulesetSendingResult TestInboxRulesetSending(TestInboxRulesetSendingOptions testInboxRulesetSendingOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
TestInboxRulesetSendingResult	TestInboxRulesetSendingResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetSendingAsync(TestInboxRulesetSendingOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions, int)

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

Declaration

public ApiResponse<TestInboxRulesetSendingResult> TestInboxRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions testInboxRulesetSendingOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<TestInboxRulesetSendingResult>	ApiResponse of TestInboxRulesetSendingResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetSendingWithHttpInfoAsync(TestInboxRulesetSendingOptions, int, CancellationToken)

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

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetWithHttpInfo(Guid, InboxRulesetTestOptions, int)

Test an inbox ruleset Test an inbox ruleset

Declaration

public ApiResponse<InboxRulesetTestResult> TestInboxRulesetWithHttpInfo(Guid id, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0)

Parameters

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

TestInboxRulesetWithHttpInfoAsync(Guid, InboxRulesetTestOptions, int, CancellationToken)

Test an inbox ruleset Test an inbox ruleset

Declaration

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

Parameters

Type	Name	Description
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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetsForInbox(Guid, InboxRulesetTestOptions, int)

Test inbox rulesets for inbox Test inbox rulesets for inbox

Declaration

public InboxRulesetTestResult TestInboxRulesetsForInbox(Guid inboxId, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
InboxRulesetTestResult	InboxRulesetTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetsForInboxAsync(Guid, InboxRulesetTestOptions, int, CancellationToken)

Test inbox rulesets for inbox Test inbox rulesets for inbox

Declaration

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

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestInboxRulesetsForInboxWithHttpInfo(Guid, InboxRulesetTestOptions, int)

Test inbox rulesets for inbox Test inbox rulesets for inbox

Declaration

public ApiResponse<InboxRulesetTestResult> TestInboxRulesetsForInboxWithHttpInfo(Guid inboxId, InboxRulesetTestOptions inboxRulesetTestOptions, int operationIndex = 0)

Parameters

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

TestInboxRulesetsForInboxWithHttpInfoAsync(Guid, InboxRulesetTestOptions, int, CancellationToken)

Test inbox rulesets for inbox Test inbox rulesets for inbox

Declaration

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

Parameters

Type	Name	Description
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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestNewInboxRuleset(TestNewInboxRulesetOptions, int)

Test new inbox ruleset Test new inbox ruleset

Declaration

public InboxRulesetTestResult TestNewInboxRuleset(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

TestNewInboxRulesetAsync(TestNewInboxRulesetOptions, int, CancellationToken)

Test new inbox ruleset Test new inbox ruleset

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestNewInboxRulesetWithHttpInfo(TestNewInboxRulesetOptions, int)

Test new inbox ruleset Test new inbox ruleset

Declaration

public ApiResponse<InboxRulesetTestResult> TestNewInboxRulesetWithHttpInfo(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

TestNewInboxRulesetWithHttpInfoAsync(TestNewInboxRulesetOptions, int, CancellationToken)

Test new inbox ruleset Test new inbox ruleset

Declaration

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IInboxRulesetControllerApi

IInboxRulesetControllerApiSync

IInboxRulesetControllerApiAsync

IApiAccessor