Struct maildir::Maildir

pub struct Maildir { /* fields omitted */ }

The main entry point for this library. This struct can be instantiated from a path using the from implementations. The path passed in to the from should be the root of the maildir (the folder containing cur, new, and tmp).

Methods

impl Maildir

pub fn path(&self) -> &Path

Returns the path of the maildir base folder.

pub fn count_new(&self) -> usize

Returns the number of messages found inside the new maildir folder.

pub fn count_cur(&self) -> usize

Returns the number of messages found inside the cur maildir folder.

Important traits for MailEntries

impl Iterator for MailEntries type Item = Result<MailEntry>;

pub fn list_new(&self) -> MailEntries

Returns an iterator over the messages inside the new maildir folder. The order of messages in the iterator is not specified, and is not guaranteed to be stable over multiple invocations of this method.

Important traits for MailEntries

impl Iterator for MailEntries type Item = Result<MailEntry>;

pub fn list_cur(&self) -> MailEntries

Returns an iterator over the messages inside the cur maildir folder. The order of messages in the iterator is not specified, and is not guaranteed to be stable over multiple invocations of this method.

pub fn move_new_to_cur(&self, id: &str) -> Result<()>

Moves a message from the new maildir folder to the cur maildir folder. The id passed in should be obtained from the iterator produced by list_new.

pub fn move_new_to_cur_with_flags(&self, id: &str, flags: &str) -> Result<()>

Moves a message from the new maildir folder to the cur maildir folder, and sets the given flags. The id passed in should be obtained from the iterator produced by list_new.

The possible flags are described e.g. at https://cr.yp.to/proto/maildir.html or http://www.courier-mta.org/maildir.html.

pub fn find(&self, id: &str) -> Option<MailEntry>

Tries to find the message with the given id in the maildir. This searches both the new and the cur folders.

pub fn delete(&self, id: &str) -> Result<()>

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

Creates all neccessary directories if they don't exist yet. It is the library user's responsibility to call this before using store_new.

pub fn store_new(&self, data: &[u8]) -> Result<String, MaildirError>

Stores the given message data as a new message file in the Maildir new folder. Does not create the neccessary directories, so if in doubt call create_dirs before using store_new. Returns the Id of the inserted message on success.

pub fn store_cur_with_flags(
    &self,
    data: &[u8],
    flags: &str
) -> Result<String, MaildirError>

Stores the given message data as a new message file in the Maildir cur folder, adding the given flags to it. The possible flags are explained e.g. at https://cr.yp.to/proto/maildir.html or http://www.courier-mta.org/maildir.html. Returns the Id of the inserted message on success.

Trait Implementations

impl From<PathBuf> for Maildir

fn from(p: PathBuf) -> Maildir

Performs the conversion.

impl From<String> for Maildir

fn from(s: String) -> Maildir

Performs the conversion.

impl<'a> From<&'a str> for Maildir

fn from(s: &str) -> Maildir

Performs the conversion.