Struct imap::types::Fetch

pub struct Fetch<'a> {
    pub message: Seq,
    pub uid: Option<Uid>,
    pub size: Option<u32>,
    /* private fields */
}

An IMAP FETCH response that contains data about a particular message. This response occurs as the result of a FETCH or STORE command, as well as by unilateral server decision (e.g., flag updates).

Fields

message: Seq

The ordinal number of this message in its containing mailbox.

uid: Option<Uid>

A number expressing the unique identifier of the message. Only present if UID was specified in the query argument to FETCH and the server supports UIDs.

size: Option<u32>

A number expressing the RFC-2822 size of the message. Only present if RFC822.SIZE was specified in the query argument to FETCH.

Implementations

impl<'a> Fetch<'a>

pub fn flags(&self) -> &[Flag<'a>]

A list of flags that are set for this message.

pub fn mod_seq(&self) -> Option<u64>

Contains the mod sequence of the performed operation if in response to a STORE or UID STORE with UNCHANGEDSINCE in the query arguments. UNCHANGEDSINCE and the inclusion of the mod sequence in the response are part of the QRESYNC extension.

pub fn header(&self) -> Option<&[u8]>

The bytes that make up the header of this message, if BODY[HEADER], BODY.PEEK[HEADER], or RFC822.HEADER was included in the query argument to FETCH.

pub fn body(&self) -> Option<&[u8]>

The bytes that make up this message, included if BODY[] or RFC822 was included in the query argument to FETCH. The bytes SHOULD be interpreted by the client according to the content transfer encoding, body type, and subtype.

pub fn text(&self) -> Option<&[u8]>

The bytes that make up the text of this message, included if BODY[TEXT], RFC822.TEXT, or BODY.PEEK[TEXT] was included in the query argument to FETCH. The bytes SHOULD be interpreted by the client according to the content transfer encoding, body type, and subtype.

pub fn envelope(&self) -> Option<&Envelope<'_>>

The envelope of this message, if ENVELOPE was included in the query argument to FETCH. This is computed by the server by parsing the RFC-2822 header into the component parts, defaulting various fields as necessary.

The full description of the format of the envelope is given in RFC 3501 section 7.4.2.

pub fn section(&self, path: &SectionPath) -> Option<&[u8]>

Extract the bytes that makes up the given BODY[<section>] of a FETCH response.

See section 7.4.2 of RFC 3501 for details.

pub fn internal_date(&self) -> Option<DateTime<FixedOffset>>

Extract the INTERNALDATE of a FETCH response

See section 2.3.3 of RFC 3501 for details.

pub fn bodystructure(&self) -> Option<&BodyStructure<'a>>

Extract the BODYSTRUCTURE of a FETCH response

See section 2.3.6 of RFC 3501 for details.

pub fn gmail_labels(&'a self) -> Option<impl Iterator<Item = &'a str>>

Extract the X-GM-LABELS of a FETCH response

This is a Gmail-specific extension. See their developer’s page for details.

pub fn into_owned(self) -> Fetch<'static>

Get an owned copy of the Fetch.

Trait Implementations

impl<'a> Debug for Fetch<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Fetch<'a>> for Fetch<'a>

fn eq(&self, other: &Fetch<'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> Eq for Fetch<'a>

impl<'a> StructuralEq for Fetch<'a>

impl<'a> StructuralPartialEq for Fetch<'a>