Struct imap::types::Mailbox

#[non_exhaustive]
pub struct Mailbox {
    pub flags: Vec<Flag<'static>>,
    pub exists: u32,
    pub recent: u32,
    pub unseen: Option<u32>,
    pub permanent_flags: Vec<Flag<'static>>,
    pub uid_next: Option<Uid>,
    pub uid_validity: Option<u32>,
    pub highest_mod_seq: Option<u64>,
    pub is_read_only: bool,
}

Meta-information about an IMAP mailbox, as returned by SELECT and friends.

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.

flags: Vec<Flag<'static>>

Defined flags in the mailbox. See the description of the FLAGS response for more detail.

exists: u32

The number of messages in the mailbox. See the description of the EXISTS response for more detail.

recent: u32

The number of messages with the \Recent flag set. See the description of the RECENT response for more detail.

unseen: Option<u32>

The message sequence number of the first unseen message in the mailbox. If this is missing, the client can not make any assumptions about the first unseen message in the mailbox, and needs to issue a SEARCH command if it wants to find it.

permanent_flags: Vec<Flag<'static>>

A list of message flags that the client can change permanently. If this is missing, the client should assume that all flags can be changed permanently. If the client attempts to STORE a flag that is not in this list list, the server will either ignore the change or store the state change for the remainder of the current session only.

uid_next: Option<Uid>

The next unique identifier value. If this is missing, the client can not make any assumptions about the next unique identifier value.

uid_validity: Option<u32>

The unique identifier validity value. See Uid for more details. If this is missing, the server does not support unique identifiers.

highest_mod_seq: Option<u64>

The highest mod sequence for this mailbox. Used with Conditional STORE.

is_read_only: bool

The mailbox is selected read-only, or its access while selected has changed from read-write to read-only.

Trait Implementations

impl Clone for Mailbox

fn clone(&self) -> Mailbox

Returns a copy 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 Default for Mailbox

fn default() -> Mailbox

Returns the “default value” for a type.

impl Display for Mailbox

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

Formats the value using the given formatter.

impl Hash for Mailbox

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Mailbox

impl StructuralEq for Mailbox

impl StructuralPartialEq for Mailbox