ts-mailcow-api/dist/endpoints/dkim-endpoints.d.ts

TypeScript wrapper for the mailcow API.

import { CreateDkimRequest, DeleteDkimRequest, DkimEntry, DuplicateDkimRequest, MailcowResponse } from '../types';
import MailcowClient from '../index';
/**
 * Interface for all DKIM endpoints related to Mailcow.
 */
export interface DkimEndpoints {
    /**
     * Generates new DKIM keys for specified domains.
     * @param payload - Object containing details for the DKIM key generation.
     * @returns A promise that resolves to a response indicating success or failure.
     */
    create(payload: CreateDkimRequest): Promise<MailcowResponse>;
    /**
     * Duplicates a DKIM key from one domain to another.
     * @param payload - Object containing source and destination domains for the DKIM key.
     * @returns A promise that resolves to a response indicating success or failure.
     */
    duplicate(payload: DuplicateDkimRequest): Promise<MailcowResponse>;
    /**
     * Deletes DKIM keys for specified domains.
     * @param payload - Object containing a list of domains to delete DKIM keys for.
     * @returns A promise that resolves to a response indicating success or failure.
     */
    delete(payload: DeleteDkimRequest): Promise<MailcowResponse>;
    /**
     * Retrieves the DKIM public key for a specific domain.
     * @param domain - The domain to retrieve the DKIM key for.
     * @returns A promise that resolves to a `DkimEntry` object.
     */
    get(domain: string): Promise<DkimEntry>;
}
/**
 * Binder function between the MailcowClient class and the DkimEndpoints.
 * @param bind - The MailcowClient instance to bind.
 * @internal
 */
export declare function dkimEndpoints(bind: MailcowClient): DkimEndpoints;