ts-mailcow-api/dist/endpoints/queue-manager-endpoints.d.ts

TypeScript wrapper for the mailcow API.

import { MailcowResponse, QueueItem } from '../types';
import MailcowClient from '../index';
/**
 * Interface for all Queue Manager endpoints.
 */
export interface QueueManagerEndpoints {
    /**
     * Endpoint for deleting the mail queue.
     * @param action - The action to perform, should be "super_delete" to delete the mail queue.
     */
    delete(action: 'super_delete'): Promise<MailcowResponse>;
    /**
     * Endpoint for getting the current mail queue.
     */
    get(): Promise<QueueItem[]>;
    /**
     * Endpoint for flushing the mail queue.
     * @param action - The action to perform, should be "flush" to flush the mail queue.
     */
    flush(action: 'flush'): Promise<MailcowResponse>;
}
/**
 * Binder function between the MailcowClient class and the QueueManagerEndpoints.
 * @param bind - The MailcowClient to bind.
 * @internal
 */
export declare function queueManagerEndpoints(bind: MailcowClient): QueueManagerEndpoints;