MailSlurp JS

Globals / InboxRulesetControllerApi

Class: InboxRulesetControllerApi

InboxRulesetControllerApi - object-oriented interface

export

Hierarchy

  • BaseAPI

    InboxRulesetControllerApi

Index

Constructors

Properties

Methods

Constructors

constructor

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

NameTypeDefault value
configuration?Configuration-
basePathstringBASE_PATH
fetchFetchAPIportableFetch

Returns: InboxRulesetControllerApi

Properties

basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

Methods

createNewInboxRuleset

createNewInboxRuleset(createInboxRulesetOptions: CreateInboxRulesetOptions, inboxId?: string, options?: any): Promise<InboxRulesetDto>

Defined in src/generated/api.ts:24121

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

summary Create an inbox ruleset

throws {RequiredError}

memberof InboxRulesetControllerApi

Parameters:

NameTypeDescription
createInboxRulesetOptionsCreateInboxRulesetOptionscreateInboxRulesetOptions
inboxId?string-
options?any-

Returns: Promise<InboxRulesetDto>


deleteInboxRuleset

deleteInboxRuleset(id: string, options?: any): Promise

Defined in src/generated/api.ts:24142

Delete inbox ruleset

summary Delete an inbox ruleset

throws {RequiredError}

memberof InboxRulesetControllerApi

Parameters:

NameTypeDescription
idstringID of inbox ruleset
options?any-

Returns: Promise


deleteInboxRulesets

deleteInboxRulesets(inboxId?: string, options?: any): Promise

Defined in src/generated/api.ts:24156

Delete inbox rulesets. Accepts optional inboxId filter.

summary Delete inbox rulesets

throws {RequiredError}

memberof InboxRulesetControllerApi

Parameters:

NameType
inboxId?string
options?any

Returns: Promise


getInboxRuleset

getInboxRuleset(id: string, options?: any): Promise<InboxRulesetDto>

Defined in src/generated/api.ts:24170

Get inbox ruleset

summary Get an inbox ruleset

throws {RequiredError}

memberof InboxRulesetControllerApi

Parameters:

NameTypeDescription
idstringID of inbox ruleset
options?any-

Returns: Promise<InboxRulesetDto>


getInboxRulesets

getInboxRulesets(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageInboxRulesetDto>

Defined in src/generated/api.ts:24189

List all rulesets attached to an inbox

summary List inbox rulesets

throws {RequiredError}

memberof InboxRulesetControllerApi

Parameters:

NameType
inboxId?string
page?number
searchFilter?string
size?number
sort?“ASC”
options?any

Returns: Promise<PageInboxRulesetDto>


testInboxRuleset

testInboxRuleset(id: string, inboxRulesetTestOptions: InboxRulesetTestOptions, options?: any): Promise<InboxRulesetTestResult>

Defined in src/generated/api.ts:24216

Test an inbox ruleset

summary Test an inbox ruleset

throws {RequiredError}

memberof InboxRulesetControllerApi

Parameters:

NameTypeDescription
idstringID of inbox ruleset
inboxRulesetTestOptionsInboxRulesetTestOptionsinboxRulesetTestOptions
options?any-

Returns: Promise<InboxRulesetTestResult>


testInboxRulesetsForInbox

testInboxRulesetsForInbox(inboxId: string, inboxRulesetTestOptions: InboxRulesetTestOptions, options?: any): Promise<InboxRulesetTestResult>

Defined in src/generated/api.ts:24237

Test inbox rulesets for inbox

summary Test inbox rulesets for inbox

throws {RequiredError}

memberof InboxRulesetControllerApi

Parameters:

NameTypeDescription
inboxIdstringID of inbox
inboxRulesetTestOptionsInboxRulesetTestOptionsinboxRulesetTestOptions
options?any-

Returns: Promise<InboxRulesetTestResult>


testNewInboxRuleset

testNewInboxRuleset(testNewInboxRulesetOptions: TestNewInboxRulesetOptions, options?: any): Promise<InboxRulesetTestResult>

Defined in src/generated/api.ts:24258

Test new inbox ruleset

summary Test new inbox ruleset

throws {RequiredError}

memberof InboxRulesetControllerApi

Parameters:

NameTypeDescription
testNewInboxRulesetOptionsTestNewInboxRulesetOptionstestNewInboxRulesetOptions
options?any-

Returns: Promise<InboxRulesetTestResult>