Interface ForwardingEndpoints

Interface for all Forwarding Hosts endpoints.

interface ForwardingEndpoints {
    create(payload: ForwardingCreateRequest): Promise<MailcowResponse>;
    delete(payload: ForwardingDeleteRequest): Promise<MailcowResponse>;
    getAll(): Promise<ForwardingHost[]>;
}

Index

Methods

create delete getAll

Methods

create

create(payload: ForwardingCreateRequest): Promise<MailcowResponse>
Endpoint for creating forwarding host.
Parameters
- payload: ForwardingCreateRequest
  The creation payload
Returns Promise<MailcowResponse>
- Defined in src/endpoints/forwarding-endpoints.ts:18

delete

delete(payload: ForwardingDeleteRequest): Promise<MailcowResponse>
Endpoint for deleting forwarding host.
Parameters
- payload: ForwardingDeleteRequest
  The deletion payload
Returns Promise<MailcowResponse>
- Defined in src/endpoints/forwarding-endpoints.ts:12

getAll

getAll(): Promise<ForwardingHost[]>
Endpoint for getting all forwarding host.

Returns Promise<ForwardingHost[]>
- Defined in src/endpoints/forwarding-endpoints.ts:23