Enum imap_types::message::Section

pub enum Section<'a> {
    Part(Part),
    Header(Option<Part>),
    HeaderFields(Option<Part>, NonEmptyVec<AString<'a>>),
    HeaderFieldsNot(Option<Part>, NonEmptyVec<AString<'a>>),
    Text(Option<Part>),
    Mime(Part),
}

A part specifier is either a part number or one of the following: HEADER, HEADER.FIELDS, HEADER.FIELDS.NOT, MIME, and TEXT.

The HEADER, HEADER.FIELDS, and HEADER.FIELDS.NOT part specifiers refer to the [RFC-2822] header of the message or of an encapsulated [MIME-IMT] MESSAGE/RFC822 message. HEADER.FIELDS and HEADER.FIELDS.NOT are followed by a list of field-name (as defined in [RFC-2822]) names, and return a subset of the header.

The field-matching is case-insensitive but otherwise exact. Subsetting does not exclude the [RFC-2822] delimiting blank line between the header and the body; the blank line is included in all header fetches, except in the case of a message which has no body and no blank line.

The HEADER, HEADER.FIELDS, HEADER.FIELDS.NOT, and TEXT part specifiers can be the sole part specifier or can be prefixed by one or more numeric part specifiers, provided that the numeric part specifier refers to a part of type MESSAGE/RFC822.

Here is an example of a complex message with some of its part specifiers:

HEADER     ([RFC-2822] header of the message)
TEXT       ([RFC-2822] text body of the message) MULTIPART/MIXED
1          TEXT/PLAIN
2          APPLICATION/OCTET-STREAM
3          MESSAGE/RFC822
3.HEADER   ([RFC-2822] header of the message)
3.TEXT     ([RFC-2822] text body of the message) MULTIPART/MIXED
3.1        TEXT/PLAIN
3.2        APPLICATION/OCTET-STREAM
4          MULTIPART/MIXED
4.1        IMAGE/GIF
4.1.MIME   ([MIME-IMB] header for the IMAGE/GIF)
4.2        MESSAGE/RFC822
4.2.HEADER ([RFC-2822] header of the message)
4.2.TEXT   ([RFC-2822] text body of the message) MULTIPART/MIXED
4.2.1      TEXT/PLAIN
4.2.2      MULTIPART/ALTERNATIVE
4.2.2.1    TEXT/PLAIN
4.2.2.2    TEXT/RICHTEXT

Variants

Part(Part)

Header(Option<Part>)

HeaderFields(Option<Part>, NonEmptyVec<AString<'a>>)

The subset returned by HEADER.FIELDS contains only those header fields with a field-name that matches one of the names in the list.

HeaderFieldsNot(Option<Part>, NonEmptyVec<AString<'a>>)

Similarly, the subset returned by HEADER.FIELDS.NOT contains only the header fields with a non-matching field-name.

Text(Option<Part>)

The TEXT part specifier refers to the text body of the message, omitting the [RFC-2822] header.

Mime(Part)

The MIME part specifier MUST be prefixed by one or more numeric part specifiers and refers to the [MIME-IMB] header for this part.

Trait Implementations

impl<'a> Clone for Section<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Section<'a>

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

Formats the value using the given formatter.

impl<'a> Encode for Section<'a>

fn encode(&self, writer: &mut impl Write) -> Result<()>

impl<'a> Hash for Section<'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, 

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<Section<'a>> for Section<'a>

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

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

fn ne(&self, other: &Section<'a>) -> bool

This method tests for !=.

impl<'a> Eq for Section<'a>

impl<'a> StructuralEq for Section<'a>

impl<'a> StructuralPartialEq for Section<'a>