Enum MailboxRole 

#[non_exhaustive]
pub enum MailboxRole {
    Inbox,
    Trash,
    Sent,
    Drafts,
    Junk,
    Archive,
    Flagged,
    Important,
    All,
    Other(String),
}

The role of a Mailbox, identifying its common purpose (RFC 8621 §2).

Values correspond to IMAP Mailbox Name Attributes (RFC 8457), converted to lowercase. An account is not required to have Mailboxes with any particular role, and at most one Mailbox per account may hold each role.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Inbox

The primary inbox for new incoming messages.

Trash

Deleted messages.

Sent

Sent messages.

Drafts

Unsent draft messages.

Junk

Messages identified as likely spam.

Archive

Archived messages.

Flagged

Messages flagged for follow-up.

Important

Messages considered important.

All

Virtual mailbox containing all messages.

Other(String)

Any role string not recognized by this implementation.

RFC 8621 §2: “An unrecognized role SHOULD be treated as if no role were set.”

The inner string retains the original value received from the server, so this variant round-trips correctly. When sending a Mailbox/set request for a mailbox whose role came from the server, it is safe to echo the role back — or omit it by setting role to None.

Implementations

impl MailboxRole

pub fn to_wire_str(&self) -> &str

Return the RFC 8621 wire-format string for this role.

Because this method is defined inside the crate that owns MailboxRole, the match is exhaustive even though the enum is #[non_exhaustive]. Adding a new variant without updating this method is a compile error.

Trait Implementations

impl Clone for MailboxRole

fn clone(&self) -> MailboxRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MailboxRole

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MailboxRole

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for MailboxRole

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

Formats the value using the given formatter.

impl Eq for MailboxRole

impl Hash for MailboxRole

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MailboxRole

fn eq(&self, other: &MailboxRole) -> 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 Serialize for MailboxRole

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MailboxRole