Struct MailboxRights 

#[non_exhaustive]
pub struct MailboxRights {
    pub may_read_items: bool,
    pub may_add_items: bool,
    pub may_remove_items: bool,
    pub may_set_seen: bool,
    pub may_set_keywords: bool,
    pub may_create_child: bool,
    pub may_rename: bool,
    pub may_delete: bool,
    pub may_submit: bool,
    pub may_set_metadata: Option<bool>,
    pub extra: Map<String, Value>,
}

Access control rights the authenticated user holds for a Mailbox (RFC 8621 §2).

Backwards compatible with IMAP ACLs (RFC 4314).

Default produces all-false (no access), which is the most restrictive valid value and a safe starting point when constructing rights in tests or server code.

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.

may_read_items: bool

User may use this Mailbox in Email/query filters and read its emails.

may_add_items: bool

User may add mail to this Mailbox.

may_remove_items: bool

User may remove mail from this Mailbox.

may_set_seen: bool

User may add or remove the $seen keyword on emails in this Mailbox.

may_set_keywords: bool

User may add or remove keywords other than $seen on emails.

may_create_child: bool

User may create a child Mailbox under this one.

may_rename: bool

User may rename this Mailbox or move it under another parent.

may_delete: bool

User may delete this Mailbox.

may_submit: bool

Messages may be submitted directly to this Mailbox.

may_set_metadata: Option<bool>

User may modify the shared metadata of this Mailbox and of the Emails in it (draft-ietf-jmap-metadata-04 §4.1; IMAP ACL “n” right, RFC 5257). None when the server omits it: the right is present only when the metadata capability lists this type or a type it contains (§4.1).

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

Trait Implementations

impl Clone for MailboxRights

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 MailboxRights

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

Formats the value using the given formatter.

impl Default for MailboxRights

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MailboxRights

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MailboxRights

impl PartialEq for MailboxRights

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MailboxRights

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MailboxRights