Struct Imap 

pub struct Imap {
    pub facts: Facts,
    /* private fields */
}

A handle on the connection: the facts, and the thread doing the talking.

Fields

facts: Facts

Implementations

impl Imap

pub fn new(remote: Remote) -> Imap

Take an open connection onto a thread of its own.

pub fn abort(&self)

mutt’s Ctrl+G: cut the job in flight short. The socket goes down, whatever was blocked on it fails, and the next job reconnects. Does nothing when nothing is running.

pub fn progress_sink(slot: &Arc<Mutex<Option<String>>>) -> Progress

A progress callback that writes where Imap::progress can read it, for the open that happens before there is a thread.

pub fn take_progress(&mut self) -> Option<String>

The last thing the connection said it was doing, taken.

pub fn busy(&self) -> Option<&'static str>

What the connection is doing, if anything.

pub fn start(&mut self, job: Job) -> Result<()>

Send a job off, to be collected later.

pub fn collect(&mut self) -> Option<Result<Done>>

The answer, if the job is done; None while it is still running.

pub fn blocking(&mut self, job: Job) -> Result<Done>

Run a job and wait for it, the way the operations did when they held the connection themselves. Every caller that learns to collect its answer later stops calling this.

pub fn wait(&mut self) -> Result<Done>

Wait for the job in flight. The session uses this to settle what it started before asking for something else: one connection, one conversation.

pub fn take_backfill(&mut self) -> Vec<u32>

The backfill takes the UIDs the open left over; they are only handed out once.

Trait Implementations

impl Drop for Imap

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.