Enum imap_types::message::Flag

pub enum Flag<'a> {
    Seen,
    Answered,
    Flagged,
    Deleted,
    Draft,
    Extension(FlagExtension<'a>),
    Keyword(Atom<'a>),
}

There are two types of flags in IMAP4rev1: System and keyword flags.

A system flag is a flag name that is pre-defined in RFC3501. All system flags begin with “" and certain system flags (\Deleted and \Seen) have special semantics. Flags that begin with “" but are not pre-defined system flags, are extension flags. Clients MUST accept them and servers MUST NOT send them except when defined by future standard or standards-track revisions.

A keyword is defined by the server implementation. Keywords do not begin with “" and servers may permit the client to define new ones in the mailbox by sending the “*” flag ([FlagPerm::AllowNewKeyword]) in the PERMANENTFLAGS response..

Note that a flag of either type can be permanent or session-only.

Variants

Seen

Message has been read (\Seen).

Answered

Message has been answered (\Answered).

Flagged

Message is “flagged” for urgent/special attention (\Flagged).

Deleted

Message is “deleted” for removal by later EXPUNGE (\Deleted).

Draft

Message has not completed composition (marked as a draft) (\Draft).

Extension(FlagExtension<'a>)

A future expansion of a system flag.

Keyword(Atom<'a>)

A keyword.

Implementations

impl<'a> Flag<'a>

pub fn system<A>(value: A) -> Result<Self, FlagError<'a, A::Error>>where A: TryInto<Atom<'a>>,

pub fn extension<A>(value: A) -> Result<Self, FlagError<'a, A::Error>>where A: TryInto<Atom<'a>>,

pub fn system_or_extension(atom: Atom<'a>) -> Self

Trait Implementations

impl<'a> Clone for Flag<'a>

fn clone(&self) -> Flag<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Flag<'a>

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

Formats the value using the given formatter.

impl<'a> Encode for Flag<'a>

fn encode(&self, writer: &mut impl Write) -> Result<()>

fn encode_detached(&self) -> Result<Vec<u8>>

impl<'a> Hash for Flag<'a>

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<'a> PartialEq<Flag<'a>> for Flag<'a>

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

impl<'a> StructuralEq for Flag<'a>

impl<'a> StructuralPartialEq for Flag<'a>