Struct mail_parser::Message

pub struct Message<'x> {
    pub html_body: Vec<MessagePartId>,
    pub text_body: Vec<MessagePartId>,
    pub attachments: Vec<MessagePartId>,
    pub parts: Vec<MessagePart<'x>>,
    pub raw_message: Cow<'x, [u8]>,
}

An RFC5322/RFC822 message.

Fields

html_body: Vec<MessagePartId>

text_body: Vec<MessagePartId>

attachments: Vec<MessagePartId>

parts: Vec<MessagePart<'x>>

raw_message: Cow<'x, [u8]>

Implementations

impl<'x> Message<'x>

pub fn is_empty(&self) -> bool

Returns false if at least one header field was successfully parsed.

pub fn parse(raw_message: &'x [u8]) -> Option<Message<'x>>

Parses a byte slice containing the RFC5322 raw message and returns a Message struct.

This function never panics, a best-effort is made to parse the message and if no headers are found None is returned.

impl<'x> Message<'x>

pub fn get_root_part(&self) -> &MessagePart<'x>

Returns the root message part

pub fn get_header(&self, header: &str) -> Option<&HeaderValue<'_>>

Returns a parsed header.

pub fn remove_header(&mut self, header: &str) -> Option<HeaderValue<'_>>

Removed a parsed header and returns its value.

pub fn remove_header_rfc(&mut self, header: RfcHeader) -> Option<HeaderValue<'_>>

Removed a parsed RFC heade and returns its value.

pub fn get_header_raw(&self, header: &str) -> Option<&str>

Returns the raw header.

pub fn get_headers(&self) -> &[Header<'_>]

Returns an iterator over the RFC headers of this message.

pub fn get_header_values<'y: 'x>(
    &'y self,
    name: RfcHeader
) -> impl Iterator<Item = &'_ HeaderValue<'x>>

Returns an iterator over the matching RFC headers of this message.

pub fn get_headers_raw(&self) -> impl Iterator<Item = (&str, &str)>

Returns all headers in raw format

pub fn get_bcc(&self) -> &HeaderValue<'_>

Returns the BCC header field

pub fn get_cc(&self) -> &HeaderValue<'_>

Returns the CC header field

pub fn get_comments(&self) -> &HeaderValue<'_>

Returns all Comments header fields

pub fn get_date(&self) -> Option<&DateTime>

Returns the Date header field

pub fn get_from(&self) -> &HeaderValue<'_>

Returns the From header field

pub fn get_in_reply_to(&self) -> &HeaderValue<'_>

Returns all In-Reply-To header fields

pub fn get_keywords(&self) -> &HeaderValue<'_>

Returns all Keywords header fields

pub fn get_list_archive(&self) -> &HeaderValue<'_>

Returns the List-Archive header field

pub fn get_list_help(&self) -> &HeaderValue<'_>

Returns the List-Help header field

pub fn get_list_id(&self) -> &HeaderValue<'_>

Returns the List-ID header field

pub fn get_list_owner(&self) -> &HeaderValue<'_>

Returns the List-Owner header field

pub fn get_list_post(&self) -> &HeaderValue<'_>

Returns the List-Post header field

pub fn get_list_subscribe(&self) -> &HeaderValue<'_>

Returns the List-Subscribe header field

pub fn get_list_unsubscribe(&self) -> &HeaderValue<'_>

Returns the List-Unsubscribe header field

pub fn get_message_id(&self) -> Option<&str>

Returns the Message-ID header field

pub fn get_mime_version(&self) -> &HeaderValue<'_>

Returns the MIME-Version header field

pub fn get_received(&self) -> &HeaderValue<'_>

Returns all Received header fields

pub fn get_references(&self) -> &HeaderValue<'_>

Returns all References header fields

pub fn get_reply_to(&self) -> &HeaderValue<'_>

Returns the Reply-To header field

pub fn get_resent_bcc(&self) -> &HeaderValue<'_>

Returns the Resent-BCC header field

pub fn get_resent_cc(&self) -> &HeaderValue<'_>

Returns the Resent-CC header field

pub fn get_resent_date(&self) -> &HeaderValue<'_>

Returns all Resent-Date header fields

pub fn get_resent_from(&self) -> &HeaderValue<'_>

Returns the Resent-From header field

pub fn get_resent_message_id(&self) -> &HeaderValue<'_>

Returns all Resent-Message-ID header fields

pub fn get_resent_sender(&self) -> &HeaderValue<'_>

Returns the Sender header field

pub fn get_resent_to(&self) -> &HeaderValue<'_>

Returns the Resent-To header field

pub fn get_return_path(&self) -> &HeaderValue<'_>

Returns all Return-Path header fields

pub fn get_return_address(&self) -> Option<&str>

Returns the return address from either the Return-Path or From header fields

pub fn get_sender(&self) -> &HeaderValue<'_>

Returns the Sender header field

pub fn get_subject(&self) -> Option<&str>

Returns the Subject header field

pub fn get_thread_name(&self) -> Option<&str>

Returns the message thread name or ‘base subject’ as defined in RFC 5957 - Internet Message Access Protocol - SORT and THREAD Extensions (Section 2.1)

pub fn get_to(&self) -> &HeaderValue<'_>

Returns the To header field

pub fn get_body_preview(&self, preview_len: usize) -> Option<Cow<'x, str>>

Returns a preview of the message body

pub fn get_html_body(&'x self, pos: usize) -> Option<Cow<'x, str>>

Returns the transformed contents an inline HTML body part by position

pub fn get_text_body(&'x self, pos: usize) -> Option<Cow<'x, str>>

Returns the transformed contents an inline text body part by position

pub fn get_part(&self, pos: usize) -> Option<&MessagePart<'_>>

Returns a message part by position

pub fn get_html_part(&self, pos: usize) -> Option<&MessagePart<'_>>

Returns an inline HTML body part by position

pub fn get_text_part(&self, pos: usize) -> Option<&MessagePart<'_>>

Returns an inline text body part by position

pub fn get_attachment(&self, pos: usize) -> Option<&MessagePart<'x>>

Returns an attacment by position

pub fn get_text_body_count(&self) -> usize

Returns the number of plain text body parts

pub fn get_html_body_count(&self) -> usize

Returns the number of HTML body parts

pub fn get_attachment_count(&self) -> usize

Returns the number of attachments

pub fn get_text_bodies(&'x self) -> BodyPartIterator<'x>

Returns an Interator over the text body parts

pub fn get_html_bodies(&'x self) -> BodyPartIterator<'x>

Returns an Interator over the HTML body parts

pub fn get_attachments(&'x self) -> AttachmentIterator<'x>

Returns an Interator over the attachments

Trait Implementations

impl<'x> Clone for Message<'x>

fn clone(&self) -> Message<'x>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'x> Debug for Message<'x>

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

Formats the value using the given formatter.

impl<'x> Default for Message<'x>

fn default() -> Message<'x>

Returns the “default value” for a type.

impl<'de: 'x, 'x> Deserialize<'de> for Message<'x>

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

Deserialize this value from the given Serde deserializer.

impl<'x> MimeHeaders<'x> for Message<'x>

fn get_content_description(&self) -> Option<&str>

Returns the Content-Description field

fn get_content_disposition(&self) -> Option<&ContentType<'_>>

Returns the Content-Disposition field

fn get_content_id(&self) -> Option<&str>

Returns the Content-ID field

fn get_content_transfer_encoding(&self) -> Option<&str>

Returns the Content-Encoding field

fn get_content_type(&self) -> Option<&ContentType<'_>>

Returns the Content-Type field

fn get_content_language(&self) -> &HeaderValue<'_>

Returns the Content-Language field

fn get_content_location(&self) -> Option<&str>

Returns the Content-Location field

fn get_attachment_name(&self) -> Option<&str>

Returns the attachment name, if any.

impl<'x> PartialEq<Message<'x>> for Message<'x>

fn eq(&self, other: &Message<'x>) -> 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<'x> Serialize for Message<'x>

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

Serialize this value into the given Serde serializer.

impl<'x> StructuralPartialEq for Message<'x>