@mxraven/admin - v2.1.0
    Preparing search index...

    Interface ListListenersOptions

    Options for ListenersClient.list.

    interface ListListenersOptions {
        defaultTerminalActionType?: TerminalActionType;
        listenerType?: ListenerType;
        pageSize?: number;
        pageToken?: string;
        rspamdScanningEnabled?: boolean;
        search?: string;
        signal?: AbortSignal;
        streamType?: StreamType;
    }

    Hierarchy (View Summary)

    Index
    defaultTerminalActionType? listenerType? pageSize? pageToken? rspamdScanningEnabled? search? signal? streamType?
    defaultTerminalActionType?: TerminalActionType

    Restrict to a single default terminal action.

    listenerType?: ListenerType

    Restrict to a single listener kind.

    pageSize?: number

    The maximum number of items to request per page, between 1 and 500.

    pageToken?: string

    An opaque cursor to continue from a previously returned page.

    rspamdScanningEnabled?: boolean

    Restrict to a required rspamd-scanning state.

    search?: string

    Case-insensitive search across the listener. Requires at least 3 characters.

    signal?: AbortSignal

    Cancels the request and any in-flight rate-limit backoff.

    streamType?: StreamType

    Restrict to a single mail stream.

    Settings
    Member Visibility

    On This Page
    Properties