Struct mail_builder::MessageBuilder

pub struct MessageBuilder<'x> {
    pub headers: Vec<(Cow<'x, str>, HeaderType<'x>)>,
    pub html_body: Option<MimePart<'x>>,
    pub text_body: Option<MimePart<'x>>,
    pub attachments: Option<Vec<MimePart<'x>>>,
    pub body: Option<MimePart<'x>>,
}

Builds an RFC5322 compliant MIME email message.

Fields

headers: Vec<(Cow<'x, str>, HeaderType<'x>)>

html_body: Option<MimePart<'x>>

text_body: Option<MimePart<'x>>

attachments: Option<Vec<MimePart<'x>>>

body: Option<MimePart<'x>>

Implementations

impl<'x> MessageBuilder<'x>

pub fn new() -> Self

Create a new MessageBuilder.

pub fn message_id(self, value: impl Into<MessageId<'x>>) -> Self

Set the Message-ID header. If no Message-ID header is set, one will be generated automatically.

pub fn in_reply_to(self, value: impl Into<MessageId<'x>>) -> Self

Set the In-Reply-To header.

pub fn references(self, value: impl Into<MessageId<'x>>) -> Self

Set the References header.

pub fn sender(self, value: impl Into<Address<'x>>) -> Self

Set the Sender header.

pub fn from(self, value: impl Into<Address<'x>>) -> Self

Set the From header.

pub fn to(self, value: impl Into<Address<'x>>) -> Self

Set the To header.

pub fn cc(self, value: impl Into<Address<'x>>) -> Self

Set the Cc header.

pub fn bcc(self, value: impl Into<Address<'x>>) -> Self

Set the Bcc header.

pub fn reply_to(self, value: impl Into<Address<'x>>) -> Self

Set the Reply-To header.

pub fn subject(self, value: impl Into<Text<'x>>) -> Self

Set the Subject header.

pub fn date(self, value: impl Into<Date>) -> Self

Set the Date header. If no Date header is set, one will be generated automatically.

pub fn header(
    self,
    header: impl Into<Cow<'x, str>>,
    value: impl Into<HeaderType<'x>>
) -> Self

Add a custom header.

pub fn headers<T, U, V>(self, header: T, values: U) -> Selfwhere
    T: Into<Cow<'x, str>>,
    U: IntoIterator<Item = V>,
    V: Into<HeaderType<'x>>,

Set custom headers.

pub fn text_body(self, value: impl Into<Cow<'x, str>>) -> Self

Set the plain text body of the message. Note that only one plain text body per message can be set using this function. To build more complex MIME body structures, use the body method instead.

pub fn html_body(self, value: impl Into<Cow<'x, str>>) -> Self

Set the HTML body of the message. Note that only one HTML body per message can be set using this function. To build more complex MIME body structures, use the body method instead.

pub fn binary_attachment(
    self,
    content_type: impl Into<Cow<'x, str>>,
    filename: impl Into<Cow<'x, str>>,
    value: impl Into<Cow<'x, [u8]>>
) -> Self

Add a binary attachment to the message.

pub fn text_attachment(
    self,
    content_type: impl Into<Cow<'x, str>>,
    filename: impl Into<Cow<'x, str>>,
    value: impl Into<Cow<'x, str>>
) -> Self

Add a text attachment to the message.

pub fn binary_inline(
    self,
    content_type: impl Into<Cow<'x, str>>,
    cid: impl Into<Cow<'x, str>>,
    value: impl Into<Cow<'x, [u8]>>
) -> Self

Add an inline binary to the message.

pub fn body(self, value: MimePart<'x>) -> Self

Set a custom MIME body structure.

pub fn write_to(self, output: impl Write) -> Result<()>

Build the message.

pub fn write_body(self, output: impl Write) -> Result<()>

Write the message body without headers.

pub fn write_to_vec(self) -> Result<Vec<u8>>

Build message to a Vec.

pub fn write_to_string(self) -> Result<String>

Build message to a String.

Trait Implementations

impl<'x> Clone for MessageBuilder<'x>

fn clone(&self) -> MessageBuilder<'x>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'x> Debug for MessageBuilder<'x>

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

Formats the value using the given formatter.

impl<'x> Default for MessageBuilder<'x>

fn default() -> Self

Returns the “default value” for a type.