Struct imap::types::Deleted

#[non_exhaustive]
pub struct Deleted {
    pub messages: DeletedMessages,
    pub mod_seq: Option<u64>,
}

A struct containing message sequence numbers or UID sequence sets and a mod sequence returned in response to a EXPUNGE command.

The EXPUNGE command may return several EXPUNGE responses referencing message sequence numbers, or it may return a VANISHED response referencing multiple UID values in a sequence set if the client has enabled QRESYNC. If QRESYNC is enabled, the server will also return the mod sequence of the completed operation.

Deleted implements some iterators to make it easy to use. If the caller knows that they should be receiving an EXPUNGE or VANISHED response, then they can use seqs() to get an iterator over EXPUNGE message sequence numbers, or uids() to get an iterator over the VANISHED UIDs. As a convenience Deleted also implents IntoIterator which just returns an iterator over whatever is contained within.

Examples

    .native_tls().unwrap();
// Iterate over whatever is returned
if let Ok(deleted) = session.expunge() {
    for id in &deleted {
        // Do something with id
    }
}

// Expect a VANISHED response with UIDs
if let Ok(deleted) = session.expunge() {
    for uid in deleted.uids() {
        // Do something with uid
    }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

messages: DeletedMessages

The list of messages that were expunged

mod_seq: Option<u64>

The mod sequence of the performed operation, if the QRESYNC extension is enabled.

Implementations

impl Deleted

pub fn from_expunged(v: Vec<u32>, mod_seq: Option<u64>) -> Self

Construct a new Deleted value from a vector of message sequence numbers returned in one or more EXPUNGE responses.

pub fn from_vanished(v: Vec<RangeInclusive<u32>>, mod_seq: Option<u64>) -> Self

Construct a new Deleted value from a sequence-set of UIDs returned in a VANISHED response

pub fn seqs(&self) -> impl Iterator<Item = Seq> + '_

Return an iterator over message sequence numbers from an EXPUNGE response. If the client is expecting sequence numbers this function can be used to ensure only sequence numbers returned in an EXPUNGE response are processed.

pub fn uids(&self) -> impl Iterator<Item = Uid> + '_

Return an iterator over UIDs returned in a VANISHED response. If the client is expecting UIDs this function can be used to ensure only UIDs are processed.

pub fn is_empty(&self) -> bool

Return if the set is empty

Trait Implementations

impl Clone for Deleted

fn clone(&self) -> Deleted

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Deleted

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Deleted

type Item = u32

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = u32> + 'a, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.