Struct Headers 

pub struct Headers<'m> { /* private fields */ }

The header fields of one part, in the order they were written.

Accessors that return one field (Headers::get, Headers::value, Headers::subject, …) return the last occurrence of the name, as 0.11 did. Names compare ASCII case-insensitively.

use mail_parser::{HeaderName, MessageParser};

let raw = b"Subject: first\r\nX-Tag: a\r\nSubject: second\r\n\r\nbody";
let message = MessageParser::new().parse(raw).expect("message");
let headers = message.headers();
assert_eq!(headers.len(), 3);
assert_eq!(headers.subject(), Some("second"));
assert_eq!(headers.all(HeaderName::Subject).count(), 2);
assert_eq!(headers.get("x-tag").map(|header| header.raw_value()), Some(&b" a\r\n"[..]));

Implementations

impl<'m> Headers<'m>

pub fn len(&self) -> usize

Number of header fields.

pub fn is_empty(&self) -> bool

Whether the part has no header field.

pub fn iter(&self) -> HeaderIter<'m>

Every header in document order. for header in headers does the same.

pub fn get<'n>(&self, name: impl Into<HeaderName<'n>>) -> Option<Header<'m>>

The last header with this name. A HeaderName::Other spelled like a known name finds that name.

pub fn get_key(&self, key: HeaderKey<'_>) -> Option<Header<'m>>

The last header with the name of this key; see HeaderName::key.

pub fn all<'n>(&self, name: impl Into<HeaderName<'n>>) -> NamedHeaders<'m, 'n>

Every header with this name, in document order. A HeaderName::Other spelled like a known name finds that name.

pub fn all_key<'k>(&self, key: HeaderKey<'k>) -> NamedHeaders<'m, 'k>

Every header with the name of this key, in document order; see HeaderName::key.

pub fn contains<'n>(&self, name: impl Into<HeaderName<'n>>) -> bool

Whether a header with this name is present.

pub fn has_known(&self) -> bool

Whether at least one header has a known name: a cheap test that the input looks like a message rather than arbitrary text.

pub fn value<'n>( &self, name: impl Into<HeaderName<'n>>, ) -> Option<HeaderValue<'m>>

The value of the last header with this name.

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

The Subject field, RFC 2047 encoded words decoded.

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

The Comments field, decoded.

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

The MIME-Version field, as written.

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

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

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

The From field.

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

The To field.

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

The Cc field.

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

The Bcc field.

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

The Reply-To field.

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

The Sender field.

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

Every From field, in document order.

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

Every To field, in document order.

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

Every Cc field, in document order.

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

Every Bcc field, in document order.

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

The Resent-To field.

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

The Resent-From field.

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

The Resent-Cc field.

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

The Resent-Bcc field.

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

The Resent-Sender field.

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

The List-Archive field (RFC 2369); the URLs are in crate::Mailbox::address.

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

The List-Help field (RFC 2369); the URLs are in crate::Mailbox::address.

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

The List-ID field (RFC 2919): the description in crate::Mailbox::name, the identifier in crate::Mailbox::address.

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

The List-Owner field (RFC 2369); the URLs are in crate::Mailbox::address.

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

The List-Post field (RFC 2369); the URLs are in crate::Mailbox::address.

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

The List-Subscribe field (RFC 2369); the URLs are in crate::Mailbox::address.

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

The List-Unsubscribe field (RFC 2369); the URLs are in crate::Mailbox::address.

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<&'m str>

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

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

The identifiers of the In-Reply-To field.

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

The identifiers of the References field.

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

The identifiers of the Resent-Message-ID field.

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

The Return-Path field, parsed as message identifiers (the address without angle brackets).

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

The phrases of the Keywords field.

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

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

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

The last Received field (the oldest hop).

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

Every Received field, in document order.

Trait Implementations

impl<'m> Clone for Headers<'m>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'m> Copy for Headers<'m>

impl Debug for Headers<'_>

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

Formats the value using the given formatter.

impl<'m> IntoIterator for Headers<'m>

type Item = Header<'m>

The type of the elements being iterated over.

type IntoIter = HeaderIter<'m>

Which kind of iterator are we turning this into?

fn into_iter(self) -> HeaderIter<'m>

Creates an iterator from a value.

impl<'m> IntoIterator for &Headers<'m>

type Item = Header<'m>

The type of the elements being iterated over.

type IntoIter = HeaderIter<'m>

Which kind of iterator are we turning this into?

fn into_iter(self) -> HeaderIter<'m>

Creates an iterator from a value.