Struct Email 

pub struct Email { /* private fields */ }

Available on crate feature mail only.

A thin wrapper around lettre::message::MessageBuilder for the ergonomic email construction API.

Implementations

impl Email

pub fn builder() -> Self

Start a new email builder.

pub fn from_builder(builder: MessageBuilder) -> Self

Construct an Email from an existing MessageBuilder (escape hatch).

pub fn from(self, mailbox: Mailbox) -> Self

Set the From address.

pub fn reply_to(self, mailbox: Mailbox) -> Self

Set the Reply-To address.

pub fn to(self, mailbox: Mailbox) -> Self

Add a To recipient. May be called repeatedly.

pub fn cc(self, mailbox: Mailbox) -> Self

Add a Cc recipient. May be called repeatedly.

pub fn bcc(self, mailbox: Mailbox) -> Self

Add a Bcc recipient. May be called repeatedly.

pub fn subject(self, subject: impl Into<String>) -> Self

Set the Subject.

pub fn plain(self, body: impl Into<String>) -> Result<Message, EmailError>

Terminate the builder with a plain-text body.

Errors

Returns EmailError::Build if lettre cannot build the message.

pub fn html(self, body: impl Into<String>) -> Result<Message, EmailError>

Terminate the builder with an HTML body.

Errors

Returns EmailError::Build if lettre cannot build the message.

pub fn alternative( self, plain: impl Into<String>, html: impl Into<String>, ) -> Result<Message, EmailError>

Terminate the builder with an alternative plain/HTML body (the client picks whichever it can render).

Errors

Returns EmailError::Build if lettre cannot build the message.

pub fn mixed( self, body: MultiPart, attachments: Vec<EmailAttachment>, ) -> Result<Message, EmailError>

Terminate the builder with a multipart/mixed body (a multipart body plus attachments).

Errors

Returns EmailError::Build if lettre cannot build the message.

pub fn plain_with_attachments( self, body: impl Into<String>, attachments: Vec<EmailAttachment>, ) -> Result<Message, EmailError>

Terminate the builder with a plain body plus attachments.

Errors

Returns EmailError::Build if lettre cannot build the message, or EmailError::ContentType if an attachment content type is invalid.

pub fn alternative_with_attachments( self, plain: impl Into<String>, html: impl Into<String>, attachments: Vec<EmailAttachment>, ) -> Result<Message, EmailError>

Terminate the builder with an alternative plain/HTML body plus attachments.

Errors

Returns EmailError::Build if lettre cannot build the message.

pub fn into_builder(self) -> MessageBuilder

Consume the wrapper and return the underlying MessageBuilder (escape hatch).

Trait Implementations

impl Clone for Email

fn clone(&self) -> Email

Returns a duplicate of the value.

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

Performs copy-assignment from source.