dovecot-auth-client/dist/types/index.d.ts

Dovecot authentication socket protocol client for Node

export interface DovecotAuthOptions {
    socketPath?: string;
    service?: string;
    timeout?: number;
}
/**
 * Authenticate a user against Dovecot's auth-client socket.
 *
 * @param username - The username to authenticate.
 * @param password - The password to authenticate.
 * @param options - Optional configuration.
 * @returns Resolves true if auth succeeded, false if not.
 */
export default function dovecotAuth(username: string, password: string, options?: DovecotAuthOptions): Promise<boolean>;