Struct Imap

pub(crate) struct Imap {
    pub(crate) idle_interrupt_receiver: Receiver<()>,
    addr: String,
    lp: Vec<ConfiguredServerLoginParam>,
    password: String,
    proxy_config: Option<ProxyConfig>,
    strict_tls: bool,
    oauth2: bool,
    authentication_failed_once: bool,
    pub(crate) connectivity: ConnectivityStore,
    conn_last_try: Time,
    conn_backoff_ms: u64,
    ratelimit: Ratelimit,
}

Fields

idle_interrupt_receiver: Receiver<()>

addr: String

Email address.

lp: Vec<ConfiguredServerLoginParam>

Login parameters.

password: String

Password.

proxy_config: Option<ProxyConfig>

Proxy configuration.

strict_tls: bool

oauth2: bool

authentication_failed_once: bool

connectivity: ConnectivityStore

conn_last_try: Time

conn_backoff_ms: u64

ratelimit: Ratelimit

Rate limit for successful IMAP connections.

This rate limit prevents busy loop in case the server refuses logins or in case connection gets dropped over and over due to IMAP bug, e.g. the server returning invalid response to SELECT command immediately after logging in or returning an error in response to LOGIN command due to internal server error.

Implementations

impl Imap

pub(crate) async fn fake_idle( &mut self, context: &Context, watch_folder: String, ) -> Result<()>

Idle using polling.

impl Imap

pub(crate) async fn scan_folders( &mut self, context: &Context, session: &mut Session, ) -> Result<bool>

Returns true if folders were scanned, false if scanning was postponed.

impl Imap

pub fn new( lp: Vec<ConfiguredServerLoginParam>, password: String, proxy_config: Option<ProxyConfig>, addr: &str, strict_tls: bool, oauth2: bool, idle_interrupt_receiver: Receiver<()>, ) -> Self

Creates new disconnected IMAP client using the specific login parameters.

addr is used to renew token if OAuth2 authentication is used.

pub async fn new_configured( context: &Context, idle_interrupt_receiver: Receiver<()>, ) -> Result<Self>

Creates new disconnected IMAP client using configured parameters.

pub(crate) async fn connect( &mut self, context: &Context, configuring: bool, ) -> Result<Session>

Connects or reconnects if needed.

It is safe to call this function if already connected, actions are performed only as needed.

Calling this function is not enough to perform IMAP operations. Use Imap::prepare instead if you are going to actually use connection rather than trying connection parameters.

pub(crate) async fn prepare(&mut self, context: &Context) -> Result<Session>

Prepare for IMAP operation.

Ensure that IMAP client is connected, folders are created and IMAP capabilities are determined.

pub async fn fetch_move_delete( &mut self, context: &Context, session: &mut Session, watch_folder: &str, folder_meaning: FolderMeaning, ) -> Result<()>

FETCH-MOVE-DELETE iteration.

Prefetches headers and downloads new message from the folder, moves messages away from the folder and deletes messages in the folder.

pub(crate) async fn fetch_new_messages( &mut self, context: &Context, session: &mut Session, folder: &str, folder_meaning: FolderMeaning, fetch_existing_msgs: bool, ) -> Result<bool>

Fetches new messages.

Returns true if at least one message was fetched.

pub(crate) async fn fetch_existing_msgs( &mut self, context: &Context, session: &mut Session, ) -> Result<()>

Read the recipients from old emails sent by the user and add them as contacts. This way, we can already offer them some email addresses they can write to.

Then, Fetch the last messages DC_FETCH_EXISTING_MSGS_COUNT emails from the server and show them in the chat list.

impl Imap

pub(crate) async fn configure_folders( &mut self, context: &Context, session: &mut Session, create_mvbox: bool, ) -> Result<()>

Trait Implementations

impl Debug for Imap

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

Formats the value using the given formatter.