MailSlurp JS / InboxForwarderControllerApi

Class: InboxForwarderControllerApi

InboxForwarderControllerApi - object-oriented interface

export

Hierarchy

  • BaseAPI

    InboxForwarderControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new InboxForwarderControllerApi(configuration?, basePath?, fetch?)

Parameters

NameType
configuration?Configuration
basePathstring
fetchFetchAPI

Inherited from

BaseAPI.constructor

Defined in

src/generated/api.ts:59

Properties

basePath

Protected basePath: string

Inherited from

BaseAPI.basePath


configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from

BaseAPI.fetch

Methods

createNewInboxForwarder

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

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>

Defined in

src/generated/api.ts:24122


deleteInboxForwarder

deleteInboxForwarder(id, options?): Promise<Response>

Delete inbox forwarder

summary Delete an inbox forwarder

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters

NameTypeDescription
idstringID of inbox forwarder
options?any-

Returns

Promise<Response>

Defined in

src/generated/api.ts:24144


deleteInboxForwarders

deleteInboxForwarders(inboxId?, options?): Promise<Response>

Delete inbox forwarders. Accepts optional inboxId filter.

summary Delete inbox forwarders

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters

NameType
inboxId?string
options?any

Returns

Promise<Response>

Defined in

src/generated/api.ts:24158


getInboxForwarder

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

Get inbox ruleset

summary Get an inbox forwarder

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters

NameTypeDescription
idstringID of inbox forwarder
options?any-

Returns

Promise<InboxForwarderDto>

Defined in

src/generated/api.ts:24172


getInboxForwarders

getInboxForwarders(before?, inboxId?, page?, searchFilter?, since?, size?, sort?, options?): Promise<PageInboxForwarderDto>

List all forwarders attached to an inbox

summary List inbox forwarders

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters

NameType
before?Date
inboxId?string
page?number
searchFilter?string
since?Date
size?number
sort?"ASC"
options?any

Returns

Promise<PageInboxForwarderDto>

Defined in

src/generated/api.ts:24192


testInboxForwarder

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

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>

Defined in

src/generated/api.ts:24225


testInboxForwardersForInbox

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

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>

Defined in

src/generated/api.ts:24248


testNewInboxForwarder

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

Test new inbox forwarder

summary Test new inbox forwarder

throws {RequiredError}

memberof InboxForwarderControllerApi

Parameters

NameTypeDescription
testNewInboxForwarderOptionsTestNewInboxForwarderOptionstestNewInboxForwarderOptions
options?any-

Returns

Promise<InboxForwarderTestResult>

Defined in

src/generated/api.ts:24270