Interface QueueManagerEndpoints

Interface for all Queue Manager endpoints.

interface QueueManagerEndpoints {
    delete(action: "super_delete"): Promise<MailcowResponse>;
    flush(action: "flush"): Promise<MailcowResponse>;
    get(): Promise<QueueItem[]>;
}

Index

Methods

delete flush get

Methods

delete

delete(action: "super_delete"): Promise<MailcowResponse>
Endpoint for deleting the mail queue.
Parameters
- action: "super_delete"
  The action to perform, should be "super_delete" to delete the mail queue.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/queue-manager-endpoints.ts:12

flush

flush(action: "flush"): Promise<MailcowResponse>
Endpoint for flushing the mail queue.
Parameters
- action: "flush"
  The action to perform, should be "flush" to flush the mail queue.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/queue-manager-endpoints.ts:23

get

get(): Promise<QueueItem[]>
Endpoint for getting the current mail queue.

Returns Promise<QueueItem[]>
- Defined in src/endpoints/queue-manager-endpoints.ts:17