Struct email::backend::imap::ImapBackend

pub struct ImapBackend { /* private fields */ }

The IMAP backend.

Implementations

impl ImapBackend

pub async fn new( account_config: AccountConfig, imap_config: ImapConfig, default_credentials: Option<String> ) -> Result<ImapBackend>

Creates a new IMAP backend.

The IMAP session is created at this moment. If the session cannot be created using the OAuth 2.0 authentication, the access token is refreshed first then a new session is created.

pub async fn notify(&mut self, keepalive: u64, folder: &str) -> Result<()>

Starts the notify daemon.

The notify service uses the IDLE IMAP mode to wait for changes on the server and to run the notify command from the account configuration in case new envelopes are available.

pub async fn watch(&mut self, keepalive: u64, folder: &str) -> Result<()>

Starts the watch daemon.

The watch service uses the IDLE IMAP mode to wait for changes on the server and to run the watch commands from the account configuration, in series.

Trait Implementations

impl Backend for ImapBackend

fn name(&self) -> String

Returns the name of the backend.

fn add_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates the given folder.

fn list_folders<'life0, 'async_trait>( &'life0 mut self ) -> Pin<Box<dyn Future<Output = Result<Folders>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Lists all available folders.

fn expunge_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Expunges the given folder.

fn purge_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Purges the given folder.

fn delete_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Definitely deletes the given folder.

fn get_envelope<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, folder: &'life1 str, uid: &'life2 str ) -> Pin<Box<dyn Future<Output = Result<Envelope>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Gets the envelope from the given folder matching the given id.

fn list_envelopes<'life0, 'life1, 'async_trait>( &'life0 mut self, folder: &'life1 str, page_size: usize, page: usize ) -> Pin<Box<dyn Future<Output = Result<Envelopes>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Lists all available envelopes from the given folder matching the given pagination.

fn search_envelopes<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, folder: &'life1 str, query: &'life2 str, sort: &'life3 str, page_size: usize, page: usize ) -> Pin<Box<dyn Future<Output = Result<Envelopes>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Sorts and filters envelopes from the given folder matching the given query, sort and pagination.

fn add_email<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, folder: &'life1 str, email: &'life2 [u8], flags: &'life3 Flags ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Adds the given raw email with the given flags to the given folder.

fn preview_emails<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, folder: &'life1 str, uids: Vec<&'life2 str> ) -> Pin<Box<dyn Future<Output = Result<Messages>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Previews emails from the given folder matching the given ids.

fn get_emails<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, folder: &'life1 str, uids: Vec<&'life2 str> ) -> Pin<Box<dyn Future<Output = Result<Messages>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Gets emails from the given folder matching the given ids.

fn copy_emails<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, from_folder: &'life1 str, to_folder: &'life2 str, uids: Vec<&'life3 str> ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Copies emails from the given folder to the given folder matching the given ids.

fn move_emails<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, from_folder: &'life1 str, to_folder: &'life2 str, uids: Vec<&'life3 str> ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Moves emails from the given folder to the given folder matching the given ids.

fn delete_emails<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, folder: &'life1 str, uids: Vec<&'life2 str> ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Deletes emails from the given folder matching the given ids.

fn add_flags<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, folder: &'life1 str, uids: Vec<&'life2 str>, flags: &'life3 Flags ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Adds the given flags to envelopes matching the given ids from the given folder.

fn set_flags<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, folder: &'life1 str, uids: Vec<&'life2 str>, flags: &'life3 Flags ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Replaces envelopes flags matching the given ids from the given folder.

fn remove_flags<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, folder: &'life1 str, uids: Vec<&'life2 str>, flags: &'life3 Flags ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Removes the given flags to envelopes matching the given ids from the given folder.

fn close(&mut self) -> Result<()>

Cleans up sessions, clients, cache etc.

fn as_any(&self) -> &dyn Any

fn mark_emails_as_deleted<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, folder: &'life1 str, ids: Vec<&'life2 str> ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Alias for adding the Deleted flag to the matching envelopes.

impl Drop for ImapBackend

fn drop(&mut self)

Executes the destructor for this type.