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

    Interface ListDomainsOptions

    Options for DomainsClient.list.

    Every filter is optional. Filters are combined with AND; results are ordered by case-insensitive domain name.

    interface ListDomainsOptions {
        dkimVerified?: boolean;
        dmarcVerified?: boolean;
        pageSize?: number;
        pageToken?: string;
        search?: string;
        sendingEnabled?: boolean;
        signal?: AbortSignal;
        spfVerified?: boolean;
        status?: DomainStatus;
    }

    Hierarchy (View Summary)

    Index
    dkimVerified? dmarcVerified? pageSize? pageToken? search? sendingEnabled? signal? spfVerified? status?
    dkimVerified?: boolean

    Restrict to a required DKIM verification state.

    dmarcVerified?: boolean

    Restrict to a required DMARC verification state.

    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.

    search?: string

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

    sendingEnabled?: boolean

    Restrict to a required sending-enabled state.

    signal?: AbortSignal

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

    spfVerified?: boolean

    Restrict to a required SPF verification state.

    status?: DomainStatus

    Restrict to a single lifecycle status.

    Settings
    Member Visibility

    On This Page
    Properties