Trait mailstrom::MailstromStorage

pub trait MailstromStorage: Send + Sync {
    type Error: MailstromStorageError;
    fn store(
        &mut self, 
        email: PreparedEmail, 
        internal_message_status: InternalMessageStatus
    ) -> Result<(), Self::Error>;
    fn update_status(
        &mut self, 
        internal_message_status: InternalMessageStatus
    ) -> Result<(), Self::Error>;
    fn retrieve(
        &self, 
        message_id: &str
    ) -> Result<(PreparedEmail, InternalMessageStatus), Self::Error>;
    fn retrieve_status(
        &self, 
        message_id: &str
    ) -> Result<InternalMessageStatus, Self::Error>;
    fn retrieve_all_incomplete(
        &self
    ) -> Result<Vec<InternalMessageStatus>, Self::Error>;
    fn retrieve_all_recent(
        &mut self
    ) -> Result<Vec<InternalMessageStatus>, Self::Error>;
}

A trait for implementing Mailstrom storage

Associated Types

type Error: MailstromStorageError

Required Methods

fn store(
    &mut self,
    email: PreparedEmail,
    internal_message_status: InternalMessageStatus
) -> Result<(), Self::Error>

Store a PreparedEmail. This should overwrite if message-id matches an existing email.

fn update_status(
    &mut self,
    internal_message_status: InternalMessageStatus
) -> Result<(), Self::Error>

Update the status of an email

fn retrieve(
    &self,
    message_id: &str
) -> Result<(PreparedEmail, InternalMessageStatus), Self::Error>

Retrieve a PreparedEmail and InternalMessageStatus based on the message_id

fn retrieve_status(
    &self,
    message_id: &str
) -> Result<InternalMessageStatus, Self::Error>

Retrieve an InternalMessageStatus based on the message_id

fn retrieve_all_incomplete(
    &self
) -> Result<Vec<InternalMessageStatus>, Self::Error>

Retrieve all incomplete emails (status only). This is used to continue retrying after shutdown and later startup.

fn retrieve_all_recent(
    &mut self
) -> Result<Vec<InternalMessageStatus>, Self::Error>

Retrieve all incomplete emails as well as all complete emails that have become complete since the last time this function was called. This can be implemented by storing a retrieved boolean as falswe when update_status saves as complete, and setting that boolean to true when this function is run.

Implementors

• impl MailstromStorage for MemoryStorage type Error = MemoryStorageError;