Struct Message 

pub struct Message<'x> { /* private fields */ }

A parsed message: the raw bytes and a store of every nested message, MIME part and header field, read through small Copy views such as MessageRef, MessagePart and crate::Header. Bodies are decoded on access.

A message is read-only, Send + Sync, and covariant in 'x, the lifetime of the raw bytes; crate::MessageParser::parse_owned and Message::into_owned give a Message<'static>. Every accessor of the root MessageRef is also available here: message.subject() is message.root().subject().

use mail_parser::{MessageParser, PartKind};

let raw = concat!(
    "From: Ann <ann@example.com>\r\n",
    "Subject: Report\r\n",
    "Content-Type: multipart/mixed; boundary=\"b\"\r\n",
    "\r\n",
    "--b\r\n",
    "Content-Type: text/plain; charset=utf-8\r\n",
    "\r\n",
    "See the attachment.\r\n",
    "--b\r\n",
    "Content-Type: application/pdf; name=report.pdf\r\n",
    "Content-Transfer-Encoding: base64\r\n",
    "\r\n",
    "JVBERi0xLjQK\r\n",
    "--b--\r\n",
);
let message = MessageParser::new().parse(raw).expect("message");
assert_eq!(message.subject(), Some("Report"));
let sender = message.from().and_then(|from| from.first());
assert_eq!(sender.and_then(|mailbox| mailbox.name()), Some("Ann"));
assert_eq!(message.body_text(0).as_deref(), Some("See the attachment."));
let attachment = message.attachments().next().expect("attachment");
assert_eq!(attachment.attachment_name(), Some("report.pdf"));
assert!(matches!(attachment.kind(), PartKind::Binary));
assert_eq!(attachment.decoded().as_ref(), b"%PDF-1.4\n");

Implementations

impl<'x> Message<'x>

pub fn raw(&self) -> &[u8]

The raw input.

pub fn root(&self) -> MessageRef<'_>

The top-level message, id 0.

pub fn messages( &self, ) -> impl ExactSizeIterator<Item = MessageRef<'_>> + DoubleEndedIterator

Every message, the root first, then nested messages in document order.

pub fn parts( &self, ) -> impl ExactSizeIterator<Item = MessagePart<'_>> + DoubleEndedIterator

Every part of every message, in document order.

pub fn part(&self, id: PartId) -> Option<MessagePart<'_>>

The part with this id; ids number every part of every message in document order.

pub fn header_count(&self) -> usize

The number of header fields of every part of every message.

pub fn part_by_boundary(&self, boundary: &str) -> Option<MessagePart<'_>>

The multipart part whose boundary parameter is boundary

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

Copies borrowed input so the message owns its bytes. Only the raw bytes are copied; the parsed store is moved.

pub fn into_buffers(self) -> MessageBuffers

Drops the message and keeps its storage, cleared, for the next crate::MessageParser::parse_with; see MessageBuffers.

pub fn root_part(&self) -> MessagePart<'_>

The root part of the root message; see MessageRef::root_part.

pub fn headers(&self) -> Headers<'_>

The header fields of the root message.

pub fn text_body(&self) -> impl ExactSizeIterator<Item = MessagePart<'_>>

The text body of the root message; see MessageRef::text_body.

pub fn html_body(&self) -> impl ExactSizeIterator<Item = MessagePart<'_>>

The HTML body of the root message; see MessageRef::html_body.

pub fn attachments(&self) -> impl ExactSizeIterator<Item = MessagePart<'_>>

The attachments of the root message; see MessageRef::attachments.

pub fn other_parts(&self) -> impl Iterator<Item = MessagePart<'_>>

The parts of the root message in no list; see MessageRef::other_parts.

pub fn has_attachments(&self) -> bool

Whether the root message has attachments; see MessageRef::has_attachments.

pub fn text_bodies(&self) -> impl Iterator<Item = Cow<'_, str>>

The text body of the root message as text; see MessageRef::text_bodies.

pub fn html_bodies(&self) -> impl Iterator<Item = Cow<'_, str>>

The HTML body of the root message as HTML; see MessageRef::html_bodies.

pub fn body_text(&self, index: usize) -> Option<Cow<'_, str>>

The text of the index-th part of the root text body; see MessageRef::body_text.

pub fn body_html(&self, index: usize) -> Option<Cow<'_, str>>

The HTML of the index-th part of the root HTML body; see MessageRef::body_html.

pub fn body_preview(&self, max_len: usize) -> Option<Cow<'_, str>>

A preview of the root message’s body; see MessageRef::body_preview.

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

The Content-Type of the root part.

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

The Content-Disposition of the root part.

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

The attachment name of the root part; see MessagePart::attachment_name.

pub fn is_content_type(&self, type_: &str, subtype: &str) -> bool

Whether the Content-Type of the root part is type_/subtype (ASCII case-insensitive).

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

The Subject field, RFC 2047 encoded words decoded.

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

The Comments field, decoded.

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

The MIME-Version field, as written.

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

The subject with reply and forward markers removed; see crate::thread_name.

pub fn from(&self) -> Option<AddressList<'_>>

The From field.

pub fn to(&self) -> Option<AddressList<'_>>

The To field.

pub fn cc(&self) -> Option<AddressList<'_>>

The Cc field.

pub fn bcc(&self) -> Option<AddressList<'_>>

The Bcc field.

pub fn reply_to(&self) -> Option<AddressList<'_>>

The Reply-To field.

pub fn sender(&self) -> Option<AddressList<'_>>

The Sender field.

pub fn all_from(&self) -> impl Iterator<Item = AddressList<'_>>

Every From field, in document order.

pub fn all_to(&self) -> impl Iterator<Item = AddressList<'_>>

Every To field, in document order.

pub fn all_cc(&self) -> impl Iterator<Item = AddressList<'_>>

Every Cc field, in document order.

pub fn all_bcc(&self) -> impl Iterator<Item = AddressList<'_>>

Every Bcc field, in document order.

pub fn resent_to(&self) -> Option<AddressList<'_>>

The Resent-To field.

pub fn resent_from(&self) -> Option<AddressList<'_>>

The Resent-From field.

pub fn resent_cc(&self) -> Option<AddressList<'_>>

The Resent-Cc field.

pub fn resent_bcc(&self) -> Option<AddressList<'_>>

The Resent-Bcc field.

pub fn resent_sender(&self) -> Option<AddressList<'_>>

The Resent-Sender field.

pub fn list_archive(&self) -> Option<AddressList<'_>>

The List-Archive field; see Headers::list_archive.

pub fn list_help(&self) -> Option<AddressList<'_>>

The List-Help field; see Headers::list_help.

pub fn list_id(&self) -> Option<AddressList<'_>>

The List-ID field; see Headers::list_id.

pub fn list_owner(&self) -> Option<AddressList<'_>>

The List-Owner field; see Headers::list_owner.

pub fn list_post(&self) -> Option<AddressList<'_>>

The List-Post field; see Headers::list_post.

pub fn list_subscribe(&self) -> Option<AddressList<'_>>

The List-Subscribe field; see Headers::list_subscribe.

pub fn list_unsubscribe(&self) -> Option<AddressList<'_>>

The List-Unsubscribe field; see Headers::list_unsubscribe.

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

The Date field.

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

The Resent-Date field.

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

The last identifier of the Message-ID field, without angle brackets.

pub fn in_reply_to(&self) -> Option<TextList<'_>>

The identifiers of the In-Reply-To field.

pub fn references(&self) -> Option<TextList<'_>>

The identifiers of the References field.

pub fn resent_message_id(&self) -> Option<TextList<'_>>

The identifiers of the Resent-Message-ID field.

pub fn return_path(&self) -> Option<TextList<'_>>

The Return-Path field; see Headers::return_path.

pub fn keywords(&self) -> Option<TextList<'_>>

The phrases of the Keywords field.

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

The last address of Return-Path, or else the first address of From.

pub fn received(&self) -> Option<Received<'_>>

The last Received field (the oldest hop).

pub fn all_received(&self) -> impl Iterator<Item = Received<'_>>

Every Received field, in document order (newest hop first).

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message<'_>

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

Formats the value using the given formatter.

impl Default for Message<'_>

fn default() -> Self

An empty message: no bytes, and a root part with no header and an empty body, in no body list.