Struct Maildir

pub struct Maildir {
    root: PathBuf,
    cur: PathBuf,
    new: PathBuf,
    tmp: PathBuf,
    info_separator: &'static str,
}

The mail directory.

A Maildir is a mail directory composed of a new, cur and tmp subdirectories.

Fields

root: PathBuf

The root path of the mail directory.

cur: PathBuf

new: PathBuf

tmp: PathBuf

info_separator: &'static str

The Maildir entry id ←→ info separator.

Implementations

impl Maildir

pub fn set_info_separator(&mut self, sep: &'static str)

pub fn with_info_separator(self, sep: &'static str) -> Self

pub fn path(&self) -> &Path

pub fn name(&self) -> Result<&str>

pub fn cur(&self) -> &Path

pub fn new(&self) -> &Path

pub fn tmp(&self) -> &Path

pub fn exists(&self) -> bool

pub fn create(&self) -> Result<()>

pub fn create_all(&self) -> Result<()>

pub fn remove(&self) -> Result<()>

Removes the cur, new and tmp directories from the current Maildir.

This function does not remove the root directory. If you want to do so, see Maildir::remove_all.

pub fn remove_all(&self) -> Result<()>

Removes the current Maildir.

This function removes the cur, new and tmp directories as well as the root directory of the current Maildir. See also Maildir::remove.

pub fn read(&self) -> Result<impl Iterator<Item = MaildirEntry> + '_>

pub fn find(&self, id: impl AsRef<str>) -> Result<Option<MaildirEntry>>

pub fn get(&self, id: impl AsRef<str>) -> Result<MaildirEntry>

pub fn write_new(&self, contents: impl AsRef<[u8]>) -> Result<MaildirEntry>

pub fn write_cur( &self, contents: impl AsRef<[u8]>, flags: impl IntoIterator<Item = Flag>, ) -> Result<MaildirEntry>

fn write( &self, contents: impl AsRef<[u8]>, flags: impl IntoIterator<Item = Flag>, new: bool, id: Option<String>, ) -> Result<MaildirEntry>

fn format_file_name(&self, id: String, flags: HashSet<Flag>) -> String

Trait Implementations

impl Clone for Maildir

fn clone(&self) -> Maildir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Maildir

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

Formats the value using the given formatter.

impl<P: Into<PathBuf>> From<P> for Maildir

fn from(root: P) -> Self

Converts to this type from the input type.

impl Hash for Maildir

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 Maildir

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

impl StructuralPartialEq for Maildir