Interface MailQueryRequest

RFC 8621 (2.3) - https://datatracker.ietf.org/doc/html/rfc8621#section-2.3

interface MailQueryRequest {
    accountId: string;
    anchor?: null | string;
    anchorOffset?: number;
    calculateTotal?: boolean;
    filter?: FilterOperator | MailFilterCondition;
    filterAsTree?: boolean;
    limit?: null | number;
    position?: number;
    sort?: null | Comparator[];
    sortAsTree?: boolean;
}

Hierarchy (View Summary)

Properties

accountId anchor? anchorOffset? calculateTotal? filter? filterAsTree? limit? position? sort? sortAsTree?

Properties

accountId

accountId: string

Optionalanchor

anchor?: null | string

OptionalanchorOffset

anchorOffset?: number

default: 0. Negative values supported

OptionalcalculateTotal

calculateTotal?: boolean

default: false

Optionalfilter

filter?: FilterOperator | MailFilterCondition

OptionalfilterAsTree

filterAsTree?: boolean

default: false

Optionallimit

limit?: null | number

uint

Optionalposition

position?: number

default: 0. Like index in array. Negative values supported

Optionalsort

sort?: null | Comparator[]

OptionalsortAsTree

sortAsTree?: boolean

default: false

Settings

Member Visibility

On This Page

Properties