Struct email::folder::Folder

pub struct Folder {
    pub kind: Option<FolderKind>,
    pub name: String,
    pub desc: String,
}

The folder structure.

The folder is just a container for emails. Depending on the backend used, the folder can be seen as a mailbox (IMAP/JMAP) or as a system directory (Maildir).

Fields

kind: Option<FolderKind>

The optional folder kind.

name: String

The folder name.

desc: String

The folder description.

The description depends on the backend used: it can be IMAP attributes or Maildir path.

Implementations

impl Folder

pub fn from_imap_name(config: &AccountConfig, name: &Name<'_>) -> Option<Self>

Parse a folder from an IMAP name.

Returns None if the folder cannot be selected.

impl Folder

pub fn from_maildir(config: &AccountConfig, mdir: Maildir) -> Option<Self>

Parse a folder from a maildir instance.

Returns None in case the folder name is too short (does not start by a dot) or is equal to notmuch (which should not be treated as a maildir folder).

impl Folder

pub fn is_inbox(&self) -> bool

Return true if the folder kind matches the Inbox variant.

pub fn is_sent(&self) -> bool

Return true if the folder kind matches the Sent variant.

pub fn is_drafts(&self) -> bool

Return true if the folder kind matches the Drafts variant.

pub fn is_trash(&self) -> bool

Return true if the folder kind matches the Trash variant.

pub fn get_kind_or_name(&self) -> &str

Return the folder kind as string slice if existing, otherwise return the folder name as string slice.

Trait Implementations

impl Clone for Folder

fn clone(&self) -> Folder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Folder

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

Formats the value using the given formatter.

impl Default for Folder

fn default() -> Folder

Returns the “default value” for a type.

impl Display for Folder

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

Formats the value using the given formatter.

impl FromIterator<Folder> for Folders

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

Creates a value from an iterator.

impl Hash for Folder

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 Folder

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