Struct Header 

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

One header field: its name, its parsed value, and where it is in the source buffer of its message (see crate::MessageRef::source).

Implementations

impl<'m> Header<'m>

pub fn name(&self) -> HeaderName<'m>

The name: a known variant, or Other with the original spelling.

pub fn raw_name(&self) -> &'m str

The name as written in the message, original case kept.

pub fn value(&self) -> HeaderValue<'m>

The value, parsed with the form the parser used for this name.

pub fn raw_value(&self) -> &'m [u8]

The bytes after the colon up to the end of the field, final line break included.

pub fn parse_as(&self, form: HeaderForm) -> ParsedValue<'m>

Parses the raw value again with another form, for names the parser kept raw or parsed differently.

use mail_parser::{HeaderForm, MessageParser};

let raw = b"X-Sender: Jane <jane@example.com>\r\n\r\nbody";
let message = MessageParser::new().parse(raw).expect("message");
let header = message.headers().get("x-sender").expect("header");
let parsed = header.parse_as(HeaderForm::Addresses);
let sender = parsed.value().as_address().and_then(|list| list.first());
assert_eq!(sender.and_then(|mailbox| mailbox.address()), Some("jane@example.com"));

pub fn offset_field(&self) -> u32

Offset of the first byte of the name in the message’s source buffer.

pub fn offset_start(&self) -> u32

Offset of the byte after the colon.

pub fn offset_end(&self) -> u32

Offset of the byte after the final line break of the field. For the last field of a header block cut short by a MIME delimiter, this is one line break past the part’s body offset.

Trait Implementations

impl<'m> Clone for Header<'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 Header<'m>

impl Debug for Header<'_>

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

Formats the value using the given formatter.