Enum vsmtp_common::queue::Queue

pub enum Queue {
    Working,
    Deliver,
    Deferred,
    Dead,
}

identifiers for all mail queues.

Variants

Working

Postq.

Deliver

1st attempt to deliver.

Deferred

1st delivery attempt failed.

Dead

Too many attempts failed.

Implementations

impl Queue

pub fn list_entries(&self, queues_dirpath: &Path) -> Result<Vec<PathBuf>>

List the files contained in the queue

Errors

• failed to initialize queue
• error while reading directory
• one entry produced an error

pub fn write_to_queue(
    &self,
    queues_dirpath: &Path,
    ctx: &MailContext
) -> Result<()>

Write a MailContext to the self queue

Errors

• the message’s metadata is ill-formed
• failed to serialize the @ctx
• failed to write on @ctx on queues_dirpath/self/ctx.id

pub async fn write_to_quarantine(path: &Path, mail: &MailContext) -> Result<()>

Write a MessageBody to path provided

Errors

• failed to open file
• failed to serialize the mail
• failed to write the mail on path

pub fn write_to_mails(
    queues_dirpath: &Path,
    message_id: &str,
    message: &MessageBody
) -> Result<()>

Errors

• failed to create the folder in queues_dirpath

pub async fn read_mail_context(
    &self,
    dirpath: &Path,
    id: &str
) -> Result<MailContext>

Errors

pub async fn read_mail_message(dirpath: &Path, id: &str) -> Result<MessageBody>

Errors

pub async fn read(
    &self,
    dirpath: &Path,
    id: &str
) -> Result<(MailContext, MessageBody)>

Return a message body from a file path. Try to parse the file as JSON, if it fails, try to parse it as plain text.

Errors

• file(s) not found
• file found but failed to read
• file read but failed to serialize

pub fn remove(&self, dirpath: &Path, id: &str) -> Result<()>

Remove a message from the queue system.

Errors

• see std::fs::remove_file

pub fn move_to(
    &self,
    other: &Self,
    queues_dirpath: &Path,
    ctx: &MailContext
) -> Result<()>

Write the ctx to other AND THEN remove ctx from self

Errors

• see Queue::write_to_queue
• see Queue::remove

Trait Implementations

impl Clone for Queue

fn clone(&self) -> Queue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Queue

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

Formats the value using the given formatter.

impl Display for Queue

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

Formats the value using the given formatter.

impl FromStr for Queue

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Queue, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl IntoEnumIterator for Queue

type Iterator = QueueIter

fn iter() -> QueueIter

impl PartialEq<Queue> for Queue

fn eq(&self, other: &Queue) -> 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 !=.

impl TryFrom<&str> for Queue

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Queue, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for Queue

impl StructuralPartialEq for Queue