ts-mailcow-api/dist/endpoints/tls-policy-map-endpoints.d.ts

TypeScript wrapper for the mailcow API.

import { AddTlsPolicyMapRequest, DeleteTlsPolicyMapRequest, MailcowResponse, TlsPolicyMap } from '../types';
import MailcowClient from '../index';
/**
 * Interface for all TLS Policy Map endpoints related to Mailcow.
 */
export interface TlsPolicyMapEndpoints {
    /**
     * Adds a new TLS Policy Map.
     * @param payload - Object containing details for the TLS Policy Map.
     * @returns A promise that resolves to a response indicating success or failure.
     */
    add(payload: AddTlsPolicyMapRequest): Promise<MailcowResponse>;
    /**
     * Deletes specified TLS Policy Maps.
     * @param payload - Object containing a list of TLS Policy Map IDs to delete.
     * @returns A promise that resolves to a response indicating success or failure.
     */
    delete(payload: DeleteTlsPolicyMapRequest): Promise<MailcowResponse>;
    /**
     * Retrieves a TLS Policy Map by ID or all maps.
     * @param id - The TLS policy map ID or 'all' to retrieve all maps.
     * @returns A promise that resolves to an array of `TlsPolicyMap` objects.
     */
    get(id: string): Promise<TlsPolicyMap[]>;
    get(id: 'all'): Promise<TlsPolicyMap[]>;
}
/**
 * Binder function between the MailcowClient class and the TlsPolicyMapEndpoints.
 * @param bind - The MailcowClient instance to bind.
 * @internal
 */
export declare function tlsPolicyMapEndpoints(bind: MailcowClient): TlsPolicyMapEndpoints;