Struct Maildir

pub struct Maildir { /* private fields */ }

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).

Implementations

impl Maildir

pub fn with_path<P: Into<PathBuf>>(p: P) -> Self

Create a Maildir from a path-compatible parameter

pub fn set_dir_mode(&mut self, dir_mode: Option<u32>)

Set the directory permission mode. By default this is left unspecified, which causes directories to be created with permissions suitable for the owner, obeying the standard unix umask semantics. If you choose to assign the permission modes here, the umask will be ignored and the explicit modes that you set will be used on any directories that are created by Maildir. This will NOT change modes on existing directories they will only be applied to directores created by this instance of Maildir

pub fn set_file_mode(&mut self, file_mode: Option<u32>)

Set the file permission mode. By default this is left unspecified, which causes files to be created with permissions suitable for the owner, obeying the standard unix umask semantics. If you choose to assign the permission modes here, the umask will be ignored and the explicit modes that you set will be used on any files that are created by Maildir. This will NOT change modes on existing files they will only be applied to files created by this instance of 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.

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.

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 list_subdirs(&self) -> MaildirEntries

Returns an iterator over the maildir subdirectories. The order of subdirectories 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 copy_to(&self, id: &str, target: &Maildir) -> Result<()>

Copies a message from the current maildir to the targetted maildir.

pub fn move_to(&self, id: &str, target: &Maildir) -> Result<()>

Moves a message from the current maildir to the targetted maildir.

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 set_flags(&self, id: &str, flags: &str) -> Result<()>

Updates the flags for the message with the given id in the maildir. This only searches the cur folder, because that’s the folder where messages have flags. Returns an error if the message was not found. All existing flags are overwritten with the new flags provided.

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

Adds the given flags to the message with the given id in the maildir. This only searches the cur folder, because that’s the folder where messages have flags. Returns an error if the message was not found. Flags are deduplicated, so setting a already-set flag has no effect.

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

Removes the given flags to the message with the given id in the maildir. This only searches the cur folder, because that’s the folder where messages have flags. Returns an error if the message was not found. If the message doesn’t have the flag(s) to be removed, those flags are ignored.

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

Deletes the message with the given id in the maildir. This searches both the new and the cur folders, and deletes the file from the filesystem. Returns an error if no message was found with the given id.

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.