Struct MailEntry 

pub struct MailEntry { /* private fields */ }

A struct representing a single email message inside the maildir.

No parsing is done. This struct only holds the path to the message file, and handles file system operations. The struct can only be created by methods in Maildir.

Implementations

impl MailEntry

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Create a new MailEntry from a path.

Errors

Will error if the path does not contain a file name part.

pub fn id(&self) -> &str

Get the unique identifier of the email message.

pub fn set_id<S: ToString>(&mut self, id: S) -> Result<(), Error>

Set the unique identifier of the email message.

This also updates the path to the email message and renames the file on the file system.

Errors

This method will return an error if the new ID is invalid or if there was an error renaming the file on the file system.

pub fn path(&self) -> &Path

Get the path to the email message.

pub fn to_path_buf(self) -> PathBuf

Takes ownership of the MailEntry and returns the base PathBuf

pub fn move_to_new(&mut self) -> Result<(), Error>

Moves the email message to the new directory.

pub fn move_to_cur(&mut self) -> Result<(), Error>

Moves the email message to the cur directory.

pub fn move_to_tmp(&mut self) -> Result<(), Error>

Moves the email message to the tmp directory.

pub fn flags(&self) -> impl Iterator<Item = &Flag>

Get the flags of the email message.

pub fn flags_to_string(&self) -> String

Get the flags of the email message as a string.

pub fn set_flag(&mut self, flag: Flag) -> Result<(), Error>

Set a flag on the email message.

This also updates the path to the email message and renames the file on the file system.

Errors

This method will return an error if there was an error renaming the file.

pub fn unset_flag(&mut self, flag: Flag) -> Result<(), Error>

Unset a flag on the email message.

This also updates the path to the email message and renames the file on the file system.

Errors

This method will return an error if there was an error renaming the file.

pub fn has_flag(&self, flag: Flag) -> bool

Returns true if the email message has the supplied flag

pub fn to_bytes(&self) -> Result<Vec<u8>>

Get the raw bytes of the email message.

Errors

This method will return an error if the email message could not be read from the file system. This could be because the path does not exists, or if there was another read error (e.g. permission denied.)

Trait Implementations

impl Debug for MailEntry

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

Formats the value using the given formatter.