Enum Flag

pub enum Flag {
    Seen,
    Answered,
    Flagged,
    Deleted,
    Draft,
    Custom(String),
}

The email envelope flag.

A flag is like a tag that can be attached to an email envelope. The concept of flag is the same across backends, but their definition may vary. For example, the flag representing answered emails is called \Answered for IMAP backend but is called R (replied) for Maildir backend. This implementation tries to be as simple as possible and should fit most of the use cases.

Variants

Seen

Flag used when the email envelope has been opened.

Answered

Flag used when the email has been answered.

Flagged

Flag used as a bookmark. The meaning is specific to the user: it could be important, starred, to check etc.

Deleted

Flag used when the email is marked for deletion.

Draft

Flag used when the email is a draft and is therefore not complete.

Custom(String)

Flag used for all other use cases.

Implementations

impl Flag

pub fn to_imap_string(&self) -> String

pub fn try_from_imap_fetch(fetch: &FlagFetch<'_>) -> Result<Self, Error>

impl Flag

pub fn custom(flag: impl ToString) -> Self

Creates a custom flag.

Trait Implementations

impl Clone for Flag

fn clone(&self) -> Flag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flag

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

Formats the value using the given formatter.

impl Display for Flag

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

Formats the value using the given formatter.

impl From<&str> for Flag

Parse a flag from a string. If the string does not match any of the existing variant, it is considered as custom.

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromIterator<Flag> for Flags

fn from_iter<T: IntoIterator<Item = Flag>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Flag

Parse a flag from a string. If the string does not match any of the existing variant, it returns an error.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl Hash for Flag

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 Ord for Flag

fn cmp(&self, other: &Flag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Flag

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

fn partial_cmp(&self, other: &Flag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&Flag> for Flag

type Error = Error

The type returned in the event of a conversion error.

fn try_from(flag: &Flag) -> Result<Self>

Performs the conversion.

impl TryFrom<Flag> for Flag

type Error = Error

The type returned in the event of a conversion error.

fn try_from(flag: Flag) -> Result<Self>

Performs the conversion.

impl TryFrom<Flag> for Flag<'static>

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(flag: Flag) -> Result<ImapFlag<'static>, Self::Error>

Performs the conversion.

impl TryFrom<Flag> for Flag

type Error = Error

The type returned in the event of a conversion error.

fn try_from(flag: Flag) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<Flag> for SearchKey<'a>

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(flag: Flag) -> Result<SearchKey<'a>, Self::Error>

Performs the conversion.

impl TryFrom<String> for Flag

Alias for FromStr.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Error>

Performs the conversion.

impl Eq for Flag

impl StructuralPartialEq for Flag