Enum FolderKind

pub enum FolderKind {
    Inbox,
    Sent,
    Drafts,
    Trash,
    UserDefined(String),
}

The folder kind enumeration.

The folder kind is a category that gives a specific purpose to a folder. It is used internally by the library to operate on the right folder.

FolderConfig::aliases allows users to map custom folder names but also to map the following folder kinds.

Variants

Inbox

The kind of folder that contains received emails.

This folder kind is mostly used for listing new or recent emails.

Sent

The kind of folder that contains sent emails.

This folder kind is used to store a copy of sent emails.

Drafts

The kind of folder than contains not finished emails.

This kind of folder is used to store drafts. Emails in this folder are supposed to be edited. Once completed they should be removed from the folder.

Trash

The kind of folder that contains trashed emails.

This kind of folder is used as a trash bin. Emails contained in this folder are supposed to be deleted.

UserDefined(String)

The user-defined kind of folder.

This kind of folder represents the alias as defined by the user in config::FolderConfig::aliases.

Implementations

impl FolderKind

pub fn is_inbox(&self) -> bool

Return true if the current folder kind matches the Inbox variant.

pub fn is_sent(&self) -> bool

Return true if the current folder kind matches the Sent variant.

pub fn is_drafts(&self) -> bool

Return true if the current folder kind matches the Drafts variant.

pub fn is_trash(&self) -> bool

Return true if the current folder kind matches the Trash variant.

pub fn is_user_defined(&self) -> bool

Return true if the current folder kind matches the UserDefined variant.

pub fn matches_inbox(folder: impl AsRef<str>) -> bool

Return true if the give string matches the Inbox variant.

pub fn matches_sent(folder: impl AsRef<str>) -> bool

Return true if the given string matches the Sent variant.

pub fn matches_drafts(folder: impl AsRef<str>) -> bool

Return true if the given string matches the Drafts variant.

pub fn matches_trash(folder: impl AsRef<str>) -> bool

Return true if the given string matches the Trash variant.

pub fn as_str(&self) -> &str

Return the folder kind as string slice.

Trait Implementations

impl Clone for FolderKind

fn clone(&self) -> FolderKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FolderKind

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

Formats the value using the given formatter.

impl Display for FolderKind

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

Formats the value using the given formatter.

impl<T: AsRef<str>> From<T> for FolderKind

fn from(kind: T) -> Self

Converts to this type from the input type.

impl FromStr for FolderKind

type Err = Error

The associated error which can be returned from parsing.

fn from_str(kind: &str) -> Result<Self>

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

impl Hash for FolderKind

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 FolderKind

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

impl StructuralPartialEq for FolderKind