Enum imap_types::search::SearchKey

pub enum SearchKey<'a> {
    And(NonEmptyVec<SearchKey<'a>>),
    SequenceSet(SequenceSet),
    All,
    Answered,
    Bcc(AString<'a>),
    Before(NaiveDate),
    Body(AString<'a>),
    Cc(AString<'a>),
    Deleted,
    Draft,
    Flagged,
    From(AString<'a>),
    Header(AString<'a>, AString<'a>),
    Keyword(Atom<'a>),
    Larger(u32),
    New,
    Not(Box<SearchKey<'a>>),
    Old,
    On(NaiveDate),
    Or(Box<SearchKey<'a>>, Box<SearchKey<'a>>),
    Recent,
    Seen,
    SentBefore(NaiveDate),
    SentOn(NaiveDate),
    SentSince(NaiveDate),
    Since(NaiveDate),
    Smaller(u32),
    Subject(AString<'a>),
    Text(AString<'a>),
    To(AString<'a>),
    Uid(SequenceSet),
    Unanswered,
    Undeleted,
    Undraft,
    Unflagged,
    Unkeyword(Atom<'a>),
    Unseen,
}

The defined search keys.

Variants

And(NonEmptyVec<SearchKey<'a>>)

SequenceSet(SequenceSet)

Messages with message sequence numbers corresponding to the specified message sequence number set.

All

All messages in the mailbox; the default initial key for ANDing.

Answered

Messages with the \Answered flag set.

Bcc(AString<'a>)

Messages that contain the specified string in the envelope structure’s BCC field.

Before(NaiveDate)

Messages whose internal date (disregarding time and timezone) is earlier than the specified date.

Body(AString<'a>)

Messages that contain the specified string in the body of the message.

Cc(AString<'a>)

Messages that contain the specified string in the envelope structure’s CC field.

Deleted

Messages with the \Deleted flag set.

Draft

Messages with the \Draft flag set.

Flagged

Messages with the \Flagged flag set.

From(AString<'a>)

Messages that contain the specified string in the envelope structure’s FROM field.

Header(AString<'a>, AString<'a>)

Messages that have a header with the specified field-name (as defined in [RFC-2822]) and that contains the specified string in the text of the header (what comes after the colon). If the string to search is zero-length, this matches all messages that have a header line with the specified field-name regardless of the contents.

Keyword(Atom<'a>)

Messages with the specified keyword flag set.

Larger(u32)

Messages with an [RFC-2822] size larger than the specified number of octets.

New

Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to “(RECENT UNSEEN)”.

Not(Box<SearchKey<'a>>)

Messages that do not match the specified search key.

Old

Messages that do not have the \Recent flag set. This is functionally equivalent to “NOT RECENT” (as opposed to “NOT NEW”).

On(NaiveDate)

Messages whose internal date (disregarding time and timezone) is within the specified date.

Or(Box<SearchKey<'a>>, Box<SearchKey<'a>>)

Messages that match either search key.

Recent

Messages that have the \Recent flag set.

Seen

Messages that have the \Seen flag set.

SentBefore(NaiveDate)

Messages whose [RFC-2822] Date: header (disregarding time and timezone) is earlier than the specified date.

SentOn(NaiveDate)

Messages whose [RFC-2822] Date: header (disregarding time and timezone) is within the specified date.

SentSince(NaiveDate)

Messages whose [RFC-2822] Date: header (disregarding time and timezone) is within or later than the specified date.

Since(NaiveDate)

Messages whose internal date (disregarding time and timezone) is within or later than the specified date.

Smaller(u32)

Messages with an [RFC-2822] size smaller than the specified number of octets.

Subject(AString<'a>)

Messages that contain the specified string in the envelope structure’s SUBJECT field.

Text(AString<'a>)

Messages that contain the specified string in the header or body of the message.

To(AString<'a>)

Messages that contain the specified string in the envelope structure’s TO field.

Uid(SequenceSet)

Messages with unique identifiers corresponding to the specified unique identifier set. Sequence set ranges are permitted.

Unanswered

Messages that do not have the \Answered flag set.

Undeleted

Messages that do not have the \Deleted flag set.

Undraft

Messages that do not have the \Draft flag set.

Unflagged

Messages that do not have the \Flagged flag set.

Unkeyword(Atom<'a>)

Messages that do not have the specified keyword flag set.

Unseen

Messages that do not have the \Seen flag set.

Implementations

impl<'a> SearchKey<'a>

pub fn uid<S>(sequence_set: S) -> Selfwhere S: Into<SequenceSet>,

Trait Implementations

impl<'a> Arbitrary<'a> for SearchKey<'a>

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<'a> Clone for SearchKey<'a>

fn clone(&self) -> SearchKey<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SearchKey<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for SearchKey<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Hash for SearchKey<'a>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> IntoBoundedStatic for SearchKey<'a>

type Static = SearchKey<'static>

The target type is bounded by the 'static lifetime.

fn into_static(self) -> Self::Static

Convert an owned T into an owned T such that T: 'static.

impl<'a> PartialEq<SearchKey<'a>> for SearchKey<'a>

fn eq(&self, other: &SearchKey<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for SearchKey<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> ToBoundedStatic for SearchKey<'a>

type Static = SearchKey<'static>

The target type is bounded by the 'static lifetime.

fn to_static(&self) -> Self::Static

Convert an &T to an owned T such that T: 'static.

impl<'a> Eq for SearchKey<'a>

impl<'a> StructuralEq for SearchKey<'a>

impl<'a> StructuralPartialEq for SearchKey<'a>