Class: InboxRulesetControllerApi

Hierarchy

  • BaseAPI

    InboxRulesetControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new InboxRulesetControllerApi(configuration?)

Parameters

NameType
configurationConfiguration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

createNewInboxRuleset

createNewInboxRuleset(requestParameters, initOverrides?): Promise<InboxRulesetDto>

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

Parameters

NameType
requestParametersCreateNewInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<InboxRulesetDto>


createNewInboxRulesetRaw

createNewInboxRulesetRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxRulesetDto»

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

Parameters

NameType
requestParametersCreateNewInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<InboxRulesetDto»


deleteInboxRuleset

deleteInboxRuleset(requestParameters, initOverrides?): Promise<void>

Delete inbox ruleset Delete an inbox ruleset

Parameters

NameType
requestParametersDeleteInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<void>


deleteInboxRulesetRaw

deleteInboxRulesetRaw(requestParameters, initOverrides?): Promise<ApiResponse<void»

Delete inbox ruleset Delete an inbox ruleset

Parameters

NameType
requestParametersDeleteInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<void»


deleteInboxRulesets

deleteInboxRulesets(requestParameters, initOverrides?): Promise<void>

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

Parameters

NameType
requestParametersDeleteInboxRulesetsRequest
initOverrides?RequestInit

Returns

Promise<void>


deleteInboxRulesetsRaw

deleteInboxRulesetsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void»

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

Parameters

NameType
requestParametersDeleteInboxRulesetsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<void»


getInboxRuleset

getInboxRuleset(requestParameters, initOverrides?): Promise<InboxRulesetDto>

Get inbox ruleset Get an inbox ruleset

Parameters

NameType
requestParametersGetInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<InboxRulesetDto>


getInboxRulesetRaw

getInboxRulesetRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxRulesetDto»

Get inbox ruleset Get an inbox ruleset

Parameters

NameType
requestParametersGetInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<InboxRulesetDto»


getInboxRulesets

getInboxRulesets(requestParameters, initOverrides?): Promise<PageInboxRulesetDto>

List all rulesets attached to an inbox List inbox rulesets

Parameters

NameType
requestParametersGetInboxRulesetsRequest
initOverrides?RequestInit

Returns

Promise<PageInboxRulesetDto>


getInboxRulesetsRaw

getInboxRulesetsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageInboxRulesetDto»

List all rulesets attached to an inbox List inbox rulesets

Parameters

NameType
requestParametersGetInboxRulesetsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<PageInboxRulesetDto»


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

NameType
contextRequestOpts
initOverrides?RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


testInboxRuleset

testInboxRuleset(requestParameters, initOverrides?): Promise<InboxRulesetTestResult>

Test an inbox ruleset Test an inbox ruleset

Parameters

NameType
requestParametersTestInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<InboxRulesetTestResult>


testInboxRulesetRaw

testInboxRulesetRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxRulesetTestResult»

Test an inbox ruleset Test an inbox ruleset

Parameters

NameType
requestParametersTestInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<InboxRulesetTestResult»


testInboxRulesetsForInbox

testInboxRulesetsForInbox(requestParameters, initOverrides?): Promise<InboxRulesetTestResult>

Test inbox rulesets for inbox Test inbox rulesets for inbox

Parameters

NameType
requestParametersTestInboxRulesetsForInboxRequest
initOverrides?RequestInit

Returns

Promise<InboxRulesetTestResult>


testInboxRulesetsForInboxRaw

testInboxRulesetsForInboxRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxRulesetTestResult»

Test inbox rulesets for inbox Test inbox rulesets for inbox

Parameters

NameType
requestParametersTestInboxRulesetsForInboxRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<InboxRulesetTestResult»


testNewInboxRuleset

testNewInboxRuleset(requestParameters, initOverrides?): Promise<InboxRulesetTestResult>

Test new inbox ruleset Test new inbox ruleset

Parameters

NameType
requestParametersTestNewInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<InboxRulesetTestResult>


testNewInboxRulesetRaw

testNewInboxRulesetRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxRulesetTestResult»

Test new inbox ruleset Test new inbox ruleset

Parameters

NameType
requestParametersTestNewInboxRulesetRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<InboxRulesetTestResult»


withMiddleware

withMiddleware<T>(…middlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...middlewaresMiddleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(…postMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...postMiddlewares(context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(…preMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...preMiddlewares(context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware