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

    Interface ListInboundRoutesOptions

    Options for InboundRoutesClient.list.

    interface ListInboundRoutesOptions {
        domainName?: string;
        mtaListenerId?: string;
        pageSize?: number;
        pageToken?: string;
        search?: string;
        signal?: AbortSignal;
        verified?: boolean;
    }

    Hierarchy (View Summary)

    Index
    domainName? mtaListenerId? pageSize? pageToken? search? signal? verified?
    domainName?: string

    Restrict to a single recipient domain.

    mtaListenerId?: string

    Restrict to a single MTA listener.

    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 route. Requires at least 3 characters.

    signal?: AbortSignal

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

    verified?: boolean

    Restrict to a required verification state.

    Settings
    Member Visibility

    On This Page
    Properties