Struct Mailbox 

#[non_exhaustive]
pub struct Mailbox {

    pub id: Id,
    pub name: String,
    pub parent_id: Option<Id>,
    pub role: Option<MailboxRole>,
    pub sort_order: u32,
    pub total_emails: u32,
    pub unread_emails: u32,
    pub total_threads: u32,
    pub unread_threads: u32,
    pub my_rights: MailboxRights,
    pub is_subscribed: bool,
    pub metadata: Option<Map<String, Value>>,
    pub private_metadata: Option<Map<String, Value>>,
    pub extra: Map<String, Value>,
}

A JMAP Mailbox object (RFC 8621 §2).

Mailboxes are the containers for Email objects. Each Email must belong to at least one Mailbox. Mailboxes form an acyclic forest via parent_id.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Id

Server-assigned immutable identifier.

name: String

User-visible name for this Mailbox.

parent_id: Option<Id>

Id of the parent Mailbox, or None if top-level; None serializes as null.

role: Option<MailboxRole>

Well-known role identifying the Mailbox’s common purpose; None serializes as null.

sort_order: u32

Client UI sort position; lower values sort first among siblings. Defaults to 0.

total_emails: u32

Total number of Emails in this Mailbox (server-set).

unread_emails: u32

Number of Emails without $seen or $draft (server-set).

total_threads: u32

Number of Threads with at least one Email in this Mailbox (server-set).

unread_threads: u32

Number of unread Threads in this Mailbox (server-set).

my_rights: MailboxRights

ACL rights the authenticated user has on this Mailbox (server-set).

is_subscribed: bool

Whether the user has subscribed to this Mailbox.

metadata: Option<Map<String, Value>>

Shared metadata, keyed by namespace identifier (draft-ietf-jmap-metadata-04 §2). Each value is a JSON object (§2.1). None when absent, which -04 §2 treats as {}; in an update a null value “is equivalent to {}” (-04 §3.2) and also decodes as None.

private_metadata: Option<Map<String, Value>>

The authenticated user’s own metadata, keyed by namespace identifier (draft-ietf-jmap-metadata-04 §2). Same shape and None handling as metadata.

extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

Implementations

impl Mailbox

pub fn new( id: Id, name: impl Into<String>, sort_order: u32, total_emails: u32, unread_emails: u32, total_threads: u32, unread_threads: u32, my_rights: MailboxRights, is_subscribed: bool, ) -> Self

Construct a Mailbox from its required fields.

parent_id and role default to None.

Trait Implementations

impl Clone for Mailbox

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Mailbox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Mailbox

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Mailbox

impl GetObject for Mailbox

impl JmapObject for Mailbox

const TYPE_NAME: &'static str = "Mailbox"

The JMAP type name string (e.g. "Email", "Mailbox", "Chat").

type Property = MailboxProperty

The property selector enum for this type (server-side only, no serde).

impl PartialEq for Mailbox

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl QueryObject for Mailbox

type Filter = Filter<MailboxFilterCondition>

The filter condition type.

type Comparator = MailboxComparator

The comparator type for sort operations.

impl Serialize for Mailbox

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SetObject for Mailbox

RFC 8621 §2 (rfc8621.txt:487, 554, 567, 572, 577, 623): id is “(immutable; server-set)”; the four counts and myRights are “(server-set)”. draft-ietf-jmap-metadata-04 §3.2: clients write metadata and privateMetadata through Foo/set.

const SERVER_SET: &'static [&'static str]

Wire names of the properties the spec marks “server-set”: “Only the server can set the value for this property. The client MUST NOT send this property when creating a new object of this type.” (RFC 8620 §1.1). A property the type’s /set method text never accepts from a client, on create or update, is server-set too.

const CLIENT_SETTABLE: &'static [&'static str]

Wire names of every property that is not SERVER_SET: the ones a client may set through /set.

const IMMUTABLE: &'static [&'static str]

The CLIENT_SETTABLE properties the spec marks “immutable”: “The value MUST NOT change after the object is created.” (RFC 8620 §1.1). A property the /set method text accepts on create but not on update is immutable too.

type Patch = PatchObject

The patch type for update operations.

impl StructuralPartialEq for Mailbox