Class InboxRulesetControllerApi

Hierarchy

BaseAPI
- InboxRulesetControllerApi

Constructors

constructor

new InboxRulesetControllerApi(configuration?: Configuration): InboxRulesetControllerApi
Parameters
- configuration: Configuration = ...
Returns InboxRulesetControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createNewInboxRuleset

createNewInboxRuleset(requestParameters: CreateNewInboxRulesetRequest, initOverrides?: RequestInit): Promise<InboxRulesetDto>
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving Create an inbox ruleset
Parameters
- requestParameters: CreateNewInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxRulesetDto>

createNewInboxRulesetRaw

createNewInboxRulesetRaw(requestParameters: CreateNewInboxRulesetRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxRulesetDto>>
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving Create an inbox ruleset
Parameters
- requestParameters: CreateNewInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRulesetDto>>

deleteInboxRuleset

deleteInboxRuleset(requestParameters: DeleteInboxRulesetRequest, initOverrides?: RequestInit): Promise<void>
Delete inbox ruleset Delete an inbox ruleset
Parameters
- requestParameters: DeleteInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteInboxRulesetRaw

deleteInboxRulesetRaw(requestParameters: DeleteInboxRulesetRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete inbox ruleset Delete an inbox ruleset
Parameters
- requestParameters: DeleteInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteInboxRulesets

deleteInboxRulesets(requestParameters: DeleteInboxRulesetsRequest, initOverrides?: RequestInit): Promise<void>
Delete inbox rulesets. Accepts optional inboxId filter. Delete inbox rulesets
Parameters
- requestParameters: DeleteInboxRulesetsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteInboxRulesetsRaw

deleteInboxRulesetsRaw(requestParameters: DeleteInboxRulesetsRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete inbox rulesets. Accepts optional inboxId filter. Delete inbox rulesets
Parameters
- requestParameters: DeleteInboxRulesetsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getInboxRuleset

getInboxRuleset(requestParameters: GetInboxRulesetRequest, initOverrides?: RequestInit): Promise<InboxRulesetDto>
Get inbox ruleset Get an inbox ruleset
Parameters
- requestParameters: GetInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxRulesetDto>

getInboxRulesetRaw

getInboxRulesetRaw(requestParameters: GetInboxRulesetRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxRulesetDto>>
Get inbox ruleset Get an inbox ruleset
Parameters
- requestParameters: GetInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRulesetDto>>

getInboxRulesets

getInboxRulesets(requestParameters: GetInboxRulesetsRequest, initOverrides?: RequestInit): Promise<PageInboxRulesetDto>
List all rulesets attached to an inbox List inbox rulesets
Parameters
- requestParameters: GetInboxRulesetsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageInboxRulesetDto>

getInboxRulesetsRaw

getInboxRulesetsRaw(requestParameters: GetInboxRulesetsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageInboxRulesetDto>>
List all rulesets attached to an inbox List inbox rulesets
Parameters
- requestParameters: GetInboxRulesetsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageInboxRulesetDto>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

testInboxRuleset

testInboxRuleset(requestParameters: TestInboxRulesetRequest, initOverrides?: RequestInit): Promise<InboxRulesetTestResult>
Test an inbox ruleset Test an inbox ruleset
Parameters
- requestParameters: TestInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxRulesetTestResult>

testInboxRulesetRaw

testInboxRulesetRaw(requestParameters: TestInboxRulesetRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxRulesetTestResult>>
Test an inbox ruleset Test an inbox ruleset
Parameters
- requestParameters: TestInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRulesetTestResult>>

testInboxRulesetReceiving

testInboxRulesetReceiving(requestParameters: TestInboxRulesetReceivingRequest, initOverrides?: RequestInit): Promise<TestInboxRulesetReceivingResult>
Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets Test receiving with inbox rulesets
Parameters
- requestParameters: TestInboxRulesetReceivingRequest
- Optional initOverrides: RequestInit
Returns Promise<TestInboxRulesetReceivingResult>

testInboxRulesetReceivingRaw

testInboxRulesetReceivingRaw(requestParameters: TestInboxRulesetReceivingRequest, initOverrides?: RequestInit): Promise<ApiResponse<TestInboxRulesetReceivingResult>>
Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets Test receiving with inbox rulesets
Parameters
- requestParameters: TestInboxRulesetReceivingRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TestInboxRulesetReceivingResult>>

testInboxRulesetSending

testInboxRulesetSending(requestParameters: TestInboxRulesetSendingRequest, initOverrides?: RequestInit): Promise<TestInboxRulesetSendingResult>
Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets Test sending with inbox rulesets
Parameters
- requestParameters: TestInboxRulesetSendingRequest
- Optional initOverrides: RequestInit
Returns Promise<TestInboxRulesetSendingResult>

testInboxRulesetSendingRaw

testInboxRulesetSendingRaw(requestParameters: TestInboxRulesetSendingRequest, initOverrides?: RequestInit): Promise<ApiResponse<TestInboxRulesetSendingResult>>
Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets Test sending with inbox rulesets
Parameters
- requestParameters: TestInboxRulesetSendingRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TestInboxRulesetSendingResult>>

testInboxRulesetsForInbox

testInboxRulesetsForInbox(requestParameters: TestInboxRulesetsForInboxRequest, initOverrides?: RequestInit): Promise<InboxRulesetTestResult>
Test inbox rulesets for inbox Test inbox rulesets for inbox
Parameters
- requestParameters: TestInboxRulesetsForInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxRulesetTestResult>

testInboxRulesetsForInboxRaw

testInboxRulesetsForInboxRaw(requestParameters: TestInboxRulesetsForInboxRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxRulesetTestResult>>
Test inbox rulesets for inbox Test inbox rulesets for inbox
Parameters
- requestParameters: TestInboxRulesetsForInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRulesetTestResult>>

testNewInboxRuleset

testNewInboxRuleset(requestParameters: TestNewInboxRulesetRequest, initOverrides?: RequestInit): Promise<InboxRulesetTestResult>
Test new inbox ruleset Test new inbox ruleset
Parameters
- requestParameters: TestNewInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxRulesetTestResult>

testNewInboxRulesetRaw

testNewInboxRulesetRaw(requestParameters: TestNewInboxRulesetRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxRulesetTestResult>>
Test new inbox ruleset Test new inbox ruleset
Parameters
- requestParameters: TestNewInboxRulesetRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxRulesetTestResult>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class InboxRulesetControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns InboxRulesetControllerApi

Properties

Protected configuration

Methods

createNewInboxRuleset

Parameters

requestParameters: CreateNewInboxRulesetRequest

Optional initOverrides: RequestInit

Returns Promise<InboxRulesetDto>

createNewInboxRulesetRaw

Parameters

requestParameters: CreateNewInboxRulesetRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<InboxRulesetDto>>

deleteInboxRuleset

Parameters

requestParameters: DeleteInboxRulesetRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteInboxRulesetRaw

Parameters

requestParameters: DeleteInboxRulesetRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

deleteInboxRulesets

Parameters

requestParameters: DeleteInboxRulesetsRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteInboxRulesetsRaw

Parameters

requestParameters: DeleteInboxRulesetsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

getInboxRuleset

Parameters

requestParameters: GetInboxRulesetRequest

Optional initOverrides: RequestInit

Returns Promise<InboxRulesetDto>

getInboxRulesetRaw

Parameters

requestParameters: GetInboxRulesetRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<InboxRulesetDto>>

getInboxRulesets

Parameters

requestParameters: GetInboxRulesetsRequest

Optional initOverrides: RequestInit

Returns Promise<PageInboxRulesetDto>

getInboxRulesetsRaw

Parameters

requestParameters: GetInboxRulesetsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<PageInboxRulesetDto>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

testInboxRuleset

Parameters

requestParameters: TestInboxRulesetRequest

Optional initOverrides: RequestInit

Returns Promise<InboxRulesetTestResult>

testInboxRulesetRaw

Parameters

requestParameters: TestInboxRulesetRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<InboxRulesetTestResult>>

testInboxRulesetReceiving

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]