MailSlurp JS

Globals / InboxForwarderControllerApi

Class: InboxForwarderControllerApi

InboxForwarderControllerApi - object-oriented interface

export

Hierarchy

  • BaseAPI

    InboxForwarderControllerApi

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: InboxForwarderControllerApi

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

createNewInboxForwarder

createNewInboxForwarder(createInboxForwarderOptions: CreateInboxForwarderOptions, inboxId?: string, options?: any): Promise<InboxForwarderDto>

Defined in src/generated/api.ts:22511

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

summary Create an inbox forwarder

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters:

NameTypeDescription
createInboxForwarderOptionsCreateInboxForwarderOptionscreateInboxForwarderOptions
inboxId?string-
options?any-

Returns: Promise<InboxForwarderDto>


deleteInboxForwarder

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

Defined in src/generated/api.ts:22533

Delete inbox forwarder

summary Delete an inbox forwarder

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters:

NameTypeDescription
idstringID of inbox forwarder
options?any-

Returns: Promise


deleteInboxForwarders

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

Defined in src/generated/api.ts:22547

Delete inbox forwarders. Accepts optional inboxId filter.

summary Delete inbox forwarders

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters:

NameType
inboxId?string
options?any

Returns: Promise


getInboxForwarder

getInboxForwarder(id: string, options?: any): Promise<InboxForwarderDto>

Defined in src/generated/api.ts:22561

Get inbox ruleset

summary Get an inbox forwarder

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters:

NameTypeDescription
idstringID of inbox forwarder
options?any-

Returns: Promise<InboxForwarderDto>


getInboxForwarders

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

Defined in src/generated/api.ts:22579

List all forwarders attached to an inbox

summary List inbox forwarders

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters:

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

Returns: Promise<PageInboxForwarderDto>


testInboxForwarder

testInboxForwarder(id: string, inboxForwarderTestOptions: InboxForwarderTestOptions, options?: any): Promise<InboxForwarderTestResult>

Defined in src/generated/api.ts:22604

Test an inbox forwarder

summary Test an inbox forwarder

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters:

NameTypeDescription
idstringID of inbox forwarder
inboxForwarderTestOptionsInboxForwarderTestOptionsinboxForwarderTestOptions
options?any-

Returns: Promise<InboxForwarderTestResult>


testInboxForwardersForInbox

testInboxForwardersForInbox(inboxForwarderTestOptions: InboxForwarderTestOptions, inboxId: string, options?: any): Promise<InboxForwarderTestResult>

Defined in src/generated/api.ts:22626

Test inbox forwarders for inbox

summary Test inbox forwarders for inbox

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters:

NameTypeDescription
inboxForwarderTestOptionsInboxForwarderTestOptionsinboxForwarderTestOptions
inboxIdstringID of inbox
options?any-

Returns: Promise<InboxForwarderTestResult>


testNewInboxForwarder

testNewInboxForwarder(testNewInboxForwarderOptions: TestNewInboxForwarderOptions, options?: any): Promise<InboxForwarderTestResult>

Defined in src/generated/api.ts:22648

Test new inbox forwarder

summary Test new inbox forwarder

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters:

NameTypeDescription
testNewInboxForwarderOptionsTestNewInboxForwarderOptionstestNewInboxForwarderOptions
options?any-

Returns: Promise<InboxForwarderTestResult>