Skip to content

Class: InboxForwarderControllerApi

Hierarchy

  • BaseAPI

    ↳ InboxForwarderControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new InboxForwarderControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

• Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

createNewInboxForwarder

▸ createNewInboxForwarder(requestParameters, initOverrides?): Promise<InboxForwarderDto>

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

Parameters

Name Type
requestParameters CreateNewInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<InboxForwarderDto>

createNewInboxForwarderRaw

▸ createNewInboxForwarderRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxForwarderDto>>

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

Parameters

Name Type
requestParameters CreateNewInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxForwarderDto>>

deleteInboxForwarder

▸ deleteInboxForwarder(requestParameters, initOverrides?): Promise<void>

Delete inbox forwarder Delete an inbox forwarder

Parameters

Name Type
requestParameters DeleteInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<void>

deleteInboxForwarderRaw

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

Delete inbox forwarder Delete an inbox forwarder

Parameters

Name Type
requestParameters DeleteInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

deleteInboxForwarders

▸ deleteInboxForwarders(requestParameters, initOverrides?): Promise<void>

Delete inbox forwarders. Accepts optional inboxId filter. Delete inbox forwarders

Parameters

Name Type
requestParameters DeleteInboxForwardersRequest
initOverrides? RequestInit

Returns

Promise<void>

deleteInboxForwardersRaw

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

Delete inbox forwarders. Accepts optional inboxId filter. Delete inbox forwarders

Parameters

Name Type
requestParameters DeleteInboxForwardersRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

getInboxForwarder

▸ getInboxForwarder(requestParameters, initOverrides?): Promise<InboxForwarderDto>

Get inbox ruleset Get an inbox forwarder

Parameters

Name Type
requestParameters GetInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<InboxForwarderDto>

getInboxForwarderRaw

▸ getInboxForwarderRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxForwarderDto>>

Get inbox ruleset Get an inbox forwarder

Parameters

Name Type
requestParameters GetInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxForwarderDto>>

getInboxForwarders

▸ getInboxForwarders(requestParameters, initOverrides?): Promise<PageInboxForwarderDto>

List all forwarders attached to an inbox List inbox forwarders

Parameters

Name Type
requestParameters GetInboxForwardersRequest
initOverrides? RequestInit

Returns

Promise<PageInboxForwarderDto>

getInboxForwardersRaw

▸ getInboxForwardersRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageInboxForwarderDto>>

List all forwarders attached to an inbox List inbox forwarders

Parameters

Name Type
requestParameters GetInboxForwardersRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageInboxForwarderDto>>

request

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

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request

testInboxForwarder

▸ testInboxForwarder(requestParameters, initOverrides?): Promise<InboxForwarderTestResult>

Test an inbox forwarder Test an inbox forwarder

Parameters

Name Type
requestParameters TestInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<InboxForwarderTestResult>

testInboxForwarderRaw

▸ testInboxForwarderRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxForwarderTestResult>>

Test an inbox forwarder Test an inbox forwarder

Parameters

Name Type
requestParameters TestInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxForwarderTestResult>>

testInboxForwardersForInbox

▸ testInboxForwardersForInbox(requestParameters, initOverrides?): Promise<InboxForwarderTestResult>

Test inbox forwarders for inbox Test inbox forwarders for inbox

Parameters

Name Type
requestParameters TestInboxForwardersForInboxRequest
initOverrides? RequestInit

Returns

Promise<InboxForwarderTestResult>

testInboxForwardersForInboxRaw

▸ testInboxForwardersForInboxRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxForwarderTestResult>>

Test inbox forwarders for inbox Test inbox forwarders for inbox

Parameters

Name Type
requestParameters TestInboxForwardersForInboxRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxForwarderTestResult>>

testNewInboxForwarder

▸ testNewInboxForwarder(requestParameters, initOverrides?): Promise<InboxForwarderTestResult>

Test new inbox forwarder Test new inbox forwarder

Parameters

Name Type
requestParameters TestNewInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<InboxForwarderTestResult>

testNewInboxForwarderRaw

▸ testNewInboxForwarderRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxForwarderTestResult>>

Test new inbox forwarder Test new inbox forwarder

Parameters

Name Type
requestParameters TestNewInboxForwarderRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxForwarderTestResult>>

withMiddleware

▸ withMiddleware<T>(...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware

withPostMiddleware

▸ withPostMiddleware<T>(...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

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

Returns

T

Inherited from

BaseAPI.withPostMiddleware

withPreMiddleware

▸ withPreMiddleware<T>(...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

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

Returns

T

Inherited from

BaseAPI.withPreMiddleware