Type Alias MailboxQueryRequestInvocationArgs

MailboxQueryRequestInvocationArgs: BaseQueryRequestInvocationArgs<
MailboxObject,
MailboxFilterCondition,
> & { filterAsTree?: boolean; sortAsTree?: boolean }

The arguments to query Mailbox objects via a Mailbox/query call

OptionalfilterAsTree?: boolean
(default: false) If true, a Mailbox is only included in the query if all its ancestors are also included in the query according to the filter.
OptionalsortAsTree?: boolean
(default: false) If true, when sorting the query results and comparing Mailboxes A and B:
- If A is an ancestor of B, it always comes first regardless of the sort comparators. Similarly, if A is descendant of B, then B always comes first.
- Otherwise, if A and B do not share a parentId, find the nearest ancestors of each that do have the same parentId and compare the sort properties on those Mailboxes instead.
The result of this is that the Mailboxes are sorted as a tree according to the parentId properties, with each set of children with a common parent sorted according to the standard sort comparators.