jmap-kit
    Preparing search index...

    Type Alias MailboxObjectSettable

    MailboxObject properties that may be set via a Mailbox/set call

    type MailboxObjectSettable = {
        isSubscribed?: boolean;
        name: string;
        parentId?: Id | null;
        role?: string | null;
        sortOrder?: UnsignedInt;
    }
    Index

    Properties

    isSubscribed? name parentId? role? sortOrder?

    Properties

    isSubscribed?: boolean

    Has the user indicated they wish to see this Mailbox in their client? This SHOULD default to false for Mailboxes in shared accounts the user has access to and true for any new Mailboxes created by the user themself. This MUST be stored separately per user where multiple users have access to a shared Mailbox.

    name: string

    User-visible name for the Mailbox, e.g., “Inbox”. This MUST be a Net-Unicode string RFC 5198 of at least 1 character in length, subject to the maximum size given in the capability object.

    parentId?: Id | null

    (default: null) The Mailbox id for the parent of this Mailbox, or null if this Mailbox is at the top level.

    role?: string | null

    (default: null) Identifies Mailboxes that have a particular common purpose (e.g., the “inbox”), regardless of the name property (which may be localised).

    sortOrder?: UnsignedInt

    (default: 0) Defines the sort order of Mailboxes when presented in the client’s UI, so it is consistent between devices. The number MUST be an integer in the range 0 <= sortOrder < 2^31.

    Settings

    Member Visibility

    On This Page

    Properties