Class InboxForwarderControllerApi

Hierarchy

BaseAPI
- InboxForwarderControllerApi

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createNewInboxForwarder

createNewInboxForwarder(requestParameters: CreateNewInboxForwarderRequest, initOverrides?: RequestInit): Promise<InboxForwarderDto>
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving Create an inbox forwarder
Parameters
- requestParameters: CreateNewInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxForwarderDto>

createNewInboxForwarderRaw

createNewInboxForwarderRaw(requestParameters: CreateNewInboxForwarderRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxForwarderDto>>
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving Create an inbox forwarder
Parameters
- requestParameters: CreateNewInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxForwarderDto>>

deleteInboxForwarder

deleteInboxForwarder(requestParameters: DeleteInboxForwarderRequest, initOverrides?: RequestInit): Promise<void>
Delete inbox forwarder Delete an inbox forwarder
Parameters
- requestParameters: DeleteInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteInboxForwarderRaw

deleteInboxForwarderRaw(requestParameters: DeleteInboxForwarderRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete inbox forwarder Delete an inbox forwarder
Parameters
- requestParameters: DeleteInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteInboxForwarders

deleteInboxForwarders(requestParameters: DeleteInboxForwardersRequest, initOverrides?: RequestInit): Promise<void>
Delete inbox forwarders. Accepts optional inboxId filter. Delete inbox forwarders
Parameters
- requestParameters: DeleteInboxForwardersRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteInboxForwardersRaw

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

getAllInboxForwarderEvents

getAllInboxForwarderEvents(requestParameters: GetAllInboxForwarderEventsRequest, initOverrides?: RequestInit): Promise<PageInboxForwarderEvents>
Get all inbox forwarder events Get all inbox forwarder events
Parameters
- requestParameters: GetAllInboxForwarderEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageInboxForwarderEvents>

getAllInboxForwarderEventsRaw

getAllInboxForwarderEventsRaw(requestParameters: GetAllInboxForwarderEventsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageInboxForwarderEvents>>
Get all inbox forwarder events Get all inbox forwarder events
Parameters
- requestParameters: GetAllInboxForwarderEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageInboxForwarderEvents>>

getForwarderEvent

getForwarderEvent(requestParameters: GetForwarderEventRequest, initOverrides?: RequestInit): Promise<InboxForwarderEventDto>
Get forwarder event Get a forwarder event
Parameters
- requestParameters: GetForwarderEventRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxForwarderEventDto>

getForwarderEventRaw

getForwarderEventRaw(requestParameters: GetForwarderEventRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxForwarderEventDto>>
Get forwarder event Get a forwarder event
Parameters
- requestParameters: GetForwarderEventRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxForwarderEventDto>>

getInboxForwarder

getInboxForwarder(requestParameters: GetInboxForwarderRequest, initOverrides?: RequestInit): Promise<InboxForwarderDto>
Get inbox forwarder Get an inbox forwarder
Parameters
- requestParameters: GetInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxForwarderDto>

getInboxForwarderEvent

getInboxForwarderEvent(requestParameters: GetInboxForwarderEventRequest, initOverrides?: RequestInit): Promise<InboxForwarderEventDto>
Get inbox forwarder event Get an inbox forwarder event
Parameters
- requestParameters: GetInboxForwarderEventRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxForwarderEventDto>

getInboxForwarderEventRaw

getInboxForwarderEventRaw(requestParameters: GetInboxForwarderEventRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxForwarderEventDto>>
Get inbox forwarder event Get an inbox forwarder event
Parameters
- requestParameters: GetInboxForwarderEventRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxForwarderEventDto>>

getInboxForwarderEvents

getInboxForwarderEvents(requestParameters: GetInboxForwarderEventsRequest, initOverrides?: RequestInit): Promise<PageInboxForwarderEvents>
Get inbox forwarder events Get an inbox forwarder event list
Parameters
- requestParameters: GetInboxForwarderEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageInboxForwarderEvents>

getInboxForwarderEventsRaw

getInboxForwarderEventsRaw(requestParameters: GetInboxForwarderEventsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageInboxForwarderEvents>>
Get inbox forwarder events Get an inbox forwarder event list
Parameters
- requestParameters: GetInboxForwarderEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageInboxForwarderEvents>>

getInboxForwarderRaw

getInboxForwarderRaw(requestParameters: GetInboxForwarderRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxForwarderDto>>
Get inbox forwarder Get an inbox forwarder
Parameters
- requestParameters: GetInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxForwarderDto>>

getInboxForwarders

getInboxForwarders(requestParameters: GetInboxForwardersRequest, initOverrides?: RequestInit): Promise<PageInboxForwarderDto>
List all forwarders attached to an inbox List inbox forwarders
Parameters
- requestParameters: GetInboxForwardersRequest
- Optional initOverrides: RequestInit
Returns Promise<PageInboxForwarderDto>

getInboxForwardersRaw

getInboxForwardersRaw(requestParameters: GetInboxForwardersRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageInboxForwarderDto>>
List all forwarders attached to an inbox List inbox forwarders
Parameters
- requestParameters: GetInboxForwardersRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageInboxForwarderDto>>

`Protected` request

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

Inherited from BaseAPI.request

testInboxForwarder

testInboxForwarder(requestParameters: TestInboxForwarderRequest, initOverrides?: RequestInit): Promise<InboxForwarderTestResult>
Test an inbox forwarder Test an inbox forwarder
Parameters
- requestParameters: TestInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxForwarderTestResult>

testInboxForwarderRaw

testInboxForwarderRaw(requestParameters: TestInboxForwarderRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxForwarderTestResult>>
Test an inbox forwarder Test an inbox forwarder
Parameters
- requestParameters: TestInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxForwarderTestResult>>

testInboxForwardersForInbox

testInboxForwardersForInbox(requestParameters: TestInboxForwardersForInboxRequest, initOverrides?: RequestInit): Promise<InboxForwarderTestResult>
Test inbox forwarders for inbox Test inbox forwarders for inbox
Parameters
- requestParameters: TestInboxForwardersForInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxForwarderTestResult>

testInboxForwardersForInboxRaw

testInboxForwardersForInboxRaw(requestParameters: TestInboxForwardersForInboxRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxForwarderTestResult>>
Test inbox forwarders for inbox Test inbox forwarders for inbox
Parameters
- requestParameters: TestInboxForwardersForInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxForwarderTestResult>>

testNewInboxForwarder

testNewInboxForwarder(requestParameters: TestNewInboxForwarderRequest, initOverrides?: RequestInit): Promise<InboxForwarderTestResult>
Test new inbox forwarder Test new inbox forwarder
Parameters
- requestParameters: TestNewInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxForwarderTestResult>

testNewInboxForwarderRaw

testNewInboxForwarderRaw(requestParameters: TestNewInboxForwarderRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxForwarderTestResult>>
Test new inbox forwarder Test new inbox forwarder
Parameters
- requestParameters: TestNewInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxForwarderTestResult>>

updateInboxForwarder

updateInboxForwarder(requestParameters: UpdateInboxForwarderRequest, initOverrides?: RequestInit): Promise<InboxForwarderDto>
Update inbox forwarder Update an inbox forwarder
Parameters
- requestParameters: UpdateInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxForwarderDto>

updateInboxForwarderRaw

updateInboxForwarderRaw(requestParameters: UpdateInboxForwarderRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxForwarderDto>>
Update inbox forwarder Update an inbox forwarder
Parameters
- requestParameters: UpdateInboxForwarderRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxForwarderDto>>

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