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 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.

role: Option<MailboxRole>

Well-known role identifying the Mailbox’s common purpose.

sort_order: u32

Client UI sort position; lower values sort first among siblings.

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.

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) -> Mailbox

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: &Mailbox) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl QueryObject for Mailbox

type Filter = MailboxFilterCondition

The filter condition type.

type Comparator = Value

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

type Patch = PatchObject

The patch type for update operations.

impl StructuralPartialEq for Mailbox