Skip to main content

SelectOptions

Struct SelectOptions 

Source
#[non_exhaustive]
pub struct SelectOptions { pub condstore: bool, pub qresync: Option<QresyncParams>, }
Expand description

Options for SELECT/EXAMINE commands beyond the basic mailbox name (RFC 3501 Sections 6.3.1/6.3.2, RFC 7162 Sections 3.1.8 and 3.2.5.2).

Used with [ImapConnection::select_with] and [ImapConnection::examine_with] to request CONDSTORE or QRESYNC extensions without requiring separate method variants for each combination.

Fields (Non-exhaustive)§

This struct is marked as 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.
§condstore: bool

Enable CONDSTORE per-message mod-sequence tracking (RFC 7162 Section 3.1.1).

When true, the server includes HIGHESTMODSEQ in the OK response and tracks per-message MODSEQ values for the selected mailbox. Requires the CONDSTORE or QRESYNC capability (RFC 7162 Section 3.1).

§qresync: Option<QresyncParams>

QRESYNC parameters for efficient delta sync (RFC 7162 Section 3.2.5.2).

Provides the server with the client’s last known UIDVALIDITY and MODSEQ so it can send VANISHED (EARLIER) and FETCH (FLAGS) for changed messages instead of a full resync. Requires the QRESYNC capability to have been enabled first (RFC 7162 Section 3.2.5).

Implementations§

Source§

impl SelectOptions

Source

pub fn condstore() -> Self

Create options with CONDSTORE enabled (RFC 7162 Section 3.1.1).

Source

pub fn qresync(params: QresyncParams) -> Self

Create options with QRESYNC parameters (RFC 7162 Section 3.2.5.2).

Trait Implementations§

Source§

impl Clone for SelectOptions

Source§

fn clone(&self) -> SelectOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SelectOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SelectOptions

Source§

fn default() -> SelectOptions

Returns the “default value” for a type. Read more
Source§

impl Hash for SelectOptions

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SelectOptions

Source§

fn eq(&self, other: &SelectOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for SelectOptions

Source§

impl StructuralPartialEq for SelectOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more