Struct mml::message::MimeBodyInterpreter

pub struct MimeBodyInterpreter {
    show_multiparts: bool,
    filter_parts: FilterParts,
    show_plain_texts_signature: bool,
    show_attachments: bool,
    show_inline_attachments: bool,
    save_attachments: bool,
    save_attachments_dir: PathBuf,
    pgp: Option<Pgp>,
    pgp_sender: Option<String>,
    pgp_recipient: Option<String>,
}

Available on crate feature interpreter only.

MIME → MML message body interpreter.

The interpreter follows the builder pattern, where the build function is named interpret_*.

Fields

show_multiparts: bool

Show multipart structure when true.

It is useful to see how nested parts are structured. If false then multipart structure is flatten, which means all parts and subparts are shown at the same top level.

filter_parts: FilterParts

Filter parts to show by MIME type.

show_plain_texts_signature: bool

If false then tries to remove signatures for text plain parts starting by the standard delimiter -- \n.

show_attachments: bool

If true then shows attachments at the end of the body as MML part.

show_inline_attachments: bool

If true then shows inline attachments at the end of the body as MML part.

save_attachments: bool

An attachment is interpreted this way: <#part filename=attachment.ext>. If true then the file (with its content) is automatically created at the given filename. Directory can be customized via save_attachments_dir. This option is particularly useful when transferring an email with its attachments.

save_attachments_dir: PathBuf

Saves attachments to the given directory instead of the default temporary one given by std::env::temp_dir().

pgp: Option<Pgp>

Available on crate feature pgp only.

pgp_sender: Option<String>

Available on crate feature pgp only.

pgp_recipient: Option<String>

Available on crate feature pgp only.

Implementations

impl MimeBodyInterpreter

pub fn default_save_attachments_dir() -> PathBuf

pub fn new() -> Self

pub fn with_show_multiparts(self, b: bool) -> Self

pub fn with_filter_parts(self, f: FilterParts) -> Self

pub fn with_show_plain_texts_signature(self, b: bool) -> Self

pub fn with_show_attachments(self, b: bool) -> Self

pub fn with_show_inline_attachments(self, b: bool) -> Self

pub fn with_save_attachments(self, b: bool) -> Self

pub fn with_save_attachments_dir(self, dir: impl Into<PathBuf>) -> Self

pub fn set_pgp(&mut self, pgp: impl Into<Pgp>)

Available on crate feature pgp only.

pub fn with_pgp(self, pgp: impl Into<Pgp>) -> Self

Available on crate feature pgp only.

pub fn set_some_pgp(&mut self, pgp: Option<impl Into<Pgp>>)

Available on crate feature pgp only.

pub fn with_some_pgp(self, pgp: Option<impl Into<Pgp>>) -> Self

Available on crate feature pgp only.

pub fn with_pgp_sender(self, sender: Option<String>) -> Self

Available on crate feature pgp only.

pub fn with_pgp_recipient(self, recipient: Option<String>) -> Self

Available on crate feature pgp only.

fn escape_mml_markup(text: String) -> String

Replace normal opening and closing tags by escaped opening and closing tags.

async fn decrypt_part(&self, encrypted_part: &MessagePart<'_>) -> Result<String>

Available on crate feature pgp only.

Decrypt the given MessagePart using PGP.

async fn verify_msg(&self, msg: &Message<'_>, ids: &[usize]) -> Result<()>

Available on crate feature pgp only.

Verify the given Message using PGP.

fn interpret_attachment( &self, ctype: &str, part: &MessagePart<'_>, data: &[u8] ) -> Result<String>

fn interpret_inline_attachment( &self, ctype: &str, part: &MessagePart<'_>, data: &[u8] ) -> Result<String>

fn interpret_text(&self, ctype: &str, text: &str) -> String

fn interpret_text_plain(&self, plain: &str) -> String

fn interpret_text_html(&self, html: &str) -> String

fn interpret_part<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self self, msg: &'life0 Message<'_>, part: &'life1 MessagePart<'_> ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

pub async fn interpret_msg<'a>(&self, msg: &Message<'a>) -> Result<String>

Interpret the given MIME Message as a MML message string.

pub async fn interpret_bytes<'a>( &self, bytes: impl AsRef<[u8]> + 'a ) -> Result<String>

Interpret the given MIME message bytes as a MML message string.

pub async fn interpret_msg_builder<'a>( &self, builder: MessageBuilder<'a> ) -> Result<String>

Interpret the given MIME MessageBuilder as a MML message string.

Trait Implementations

impl Clone for MimeBodyInterpreter

fn clone(&self) -> MimeBodyInterpreter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MimeBodyInterpreter

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

Formats the value using the given formatter.

impl Default for MimeBodyInterpreter

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for MimeBodyInterpreter

fn eq(&self, other: &MimeBodyInterpreter) -> 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 Eq for MimeBodyInterpreter

impl StructuralPartialEq for MimeBodyInterpreter