Struct Envelope

pub struct Envelope {
    pub id: String,
    pub message_id: String,
    pub in_reply_to: Option<String>,
    pub flags: Flags,
    pub from: Address,
    pub to: Address,
    pub subject: String,
    pub date: DateTime<FixedOffset>,
    pub has_attachment: bool,
}

The email envelope.

The email envelope is composed of an identifier, some flags, and few headers taken from the email message.

Fields

id: String

The shape of the envelope identifier may vary depending on the backend. For IMAP backend, it is an stringified auto-incremented integer. For Notmuch backend it is a Git-like hash.

message_id: String

The Message-ID header from the email message.

in_reply_to: Option<String>

The In-Reply-To header from the email message.

flags: Flags

The envelope flags.

from: Address

The first address from the email message header From.

to: Address

The first address from the email message header To.

subject: String

The Subject header from the email message.

date: DateTime<FixedOffset>

The Date header from the email message.

has_attachment: bool

True if the current envelope contains at least one attachment.

An attachment is defined here as a MIME part that is not a text/*.

Implementations

impl Envelope

pub fn from_imap_data_items(items: &[MessageDataItem<'_>]) -> Self

impl Envelope

pub fn from_msg(id: impl ToString, flags: Flags, msg: Message<'_>) -> Envelope

Build an envelope from an identifier, some flags and a message.

pub fn set_some_from(&mut self, addr: Option<Address>)

pub fn set_some_to(&mut self, addr: Option<Address>)

pub fn set_some_date(&mut self, date: Option<&DateTime>)

pub fn set_date(&mut self, date: &DateTime)

Transform a mail_parser::DateTime into a fixed offset chrono::DateTime and add it to the current envelope.

pub fn format_date(&self, config: &AccountConfig) -> String

Format the envelope date according to the datetime format and timezone from the account configuration.

pub fn to_sync_cache_msg(&self) -> String

Build a message from the current envelope.

The message is just composed of two headers and contains no content. It is mostly used by the synchronization to cache envelopes.

pub fn as_threaded(&self) -> ThreadedEnvelope<'_>

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl Default for Envelope

fn default() -> Envelope

Returns the “default value” for a type.

impl FromIterator<Envelope> for Envelopes

fn from_iter<T: IntoIterator<Item = Envelope>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Envelope

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Envelope

fn cmp(&self, other: &Envelope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Envelope

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Envelope

fn partial_cmp(&self, other: &Envelope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<MaildirEntry> for Envelope

type Error = Error

The type returned in the event of a conversion error.

fn try_from(entry: MaildirEntry) -> Result<Self>

Performs the conversion.

impl Eq for Envelope