Enum Flag 

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

An IMAP message flag.

System flags (prefixed with \ in the IMAP protocol) have dedicated variants. User-defined keyword flags use Flag::Keyword.

Examples

use protonmail_client::Flag;

let seen = Flag::Seen;
assert_eq!(seen.as_imap_str(), "\\Seen");

let kw = Flag::Keyword("$Important".to_string());
assert_eq!(kw.as_imap_str(), "$Important");

Variants

Seen

Message has been read (\Seen).

Answered

Message has been answered (\Answered).

Flagged

Message is flagged for attention (\Flagged).

Deleted

Message is marked for deletion (\Deleted).

Draft

Message is a draft (\Draft).

Keyword(String)

A user-defined keyword flag (no \ prefix).

Implementations

impl Flag

pub fn as_imap_str(&self) -> &str

The IMAP wire representation of this flag.

System flags include the leading backslash (e.g. \Seen). Keyword flags are returned as-is.

Trait Implementations

impl Clone for Flag

fn clone(&self) -> Flag

Returns a duplicate 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 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 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 Eq for Flag

impl StructuralPartialEq for Flag