Skip to content

Class: InboxRulesetControllerApi

Hierarchy

  • BaseAPI

    InboxRulesetControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new InboxRulesetControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

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

Name Type
requestParameters CreateNewInboxRulesetRequest
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

Name Type
requestParameters CreateNewInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxRulesetDto>>


deleteInboxRuleset

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

Delete inbox ruleset Delete an inbox ruleset

Parameters

Name Type
requestParameters DeleteInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<void>


deleteInboxRulesetRaw

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

Delete inbox ruleset Delete an inbox ruleset

Parameters

Name Type
requestParameters DeleteInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>


deleteInboxRulesets

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

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

Parameters

Name Type
requestParameters DeleteInboxRulesetsRequest
initOverrides? RequestInit

Returns

Promise<void>


deleteInboxRulesetsRaw

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

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

Parameters

Name Type
requestParameters DeleteInboxRulesetsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>


getInboxRuleset

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

Get inbox ruleset Get an inbox ruleset

Parameters

Name Type
requestParameters GetInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<InboxRulesetDto>


getInboxRulesetRaw

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

Get inbox ruleset Get an inbox ruleset

Parameters

Name Type
requestParameters GetInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxRulesetDto>>


getInboxRulesets

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

List all rulesets attached to an inbox List inbox rulesets

Parameters

Name Type
requestParameters GetInboxRulesetsRequest
initOverrides? RequestInit

Returns

Promise<PageInboxRulesetDto>


getInboxRulesetsRaw

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

List all rulesets attached to an inbox List inbox rulesets

Parameters

Name Type
requestParameters GetInboxRulesetsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageInboxRulesetDto>>


request

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

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


testInboxRuleset

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

Test an inbox ruleset Test an inbox ruleset

Parameters

Name Type
requestParameters TestInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<InboxRulesetTestResult>


testInboxRulesetRaw

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

Test an inbox ruleset Test an inbox ruleset

Parameters

Name Type
requestParameters TestInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxRulesetTestResult>>


testInboxRulesetsForInbox

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

Test inbox rulesets for inbox Test inbox rulesets for inbox

Parameters

Name Type
requestParameters TestInboxRulesetsForInboxRequest
initOverrides? RequestInit

Returns

Promise<InboxRulesetTestResult>


testInboxRulesetsForInboxRaw

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

Test inbox rulesets for inbox Test inbox rulesets for inbox

Parameters

Name Type
requestParameters TestInboxRulesetsForInboxRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxRulesetTestResult>>


testNewInboxRuleset

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

Test new inbox ruleset Test new inbox ruleset

Parameters

Name Type
requestParameters TestNewInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<InboxRulesetTestResult>


testNewInboxRulesetRaw

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

Test new inbox ruleset Test new inbox ruleset

Parameters

Name Type
requestParameters TestNewInboxRulesetRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxRulesetTestResult>>


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware