Struct MessageBuilder 

#[non_exhaustive]
pub struct MessageBuilder { /* private fields */ }

Builder for Message.

Implementations

impl MessageBuilder

pub const fn new(body: Body) -> Self

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

Sets the From mailbox.

Named from_mailbox (rather than from) to avoid shadowing the From::from trait method and the Message::from_mailbox accessor.

pub fn sender(self, sender: Mailbox) -> Self

pub fn to<I>(self, to: I) -> Self

where I: IntoIterator<Item = Address>,

Replace the entire To recipient list. To append a single recipient, use Self::add_to.

pub fn add_to(self, to: impl Into<Address>) -> Self

Append a recipient to the To list.

pub fn cc<I>(self, cc: I) -> Self

where I: IntoIterator<Item = Address>,

Replace the entire Cc recipient list. To append, use Self::add_cc.

pub fn add_cc(self, cc: impl Into<Address>) -> Self

Append a recipient to the Cc list.

pub fn bcc<I>(self, bcc: I) -> Self

where I: IntoIterator<Item = Address>,

Replace the entire Bcc recipient list. To append, use Self::add_bcc.

pub fn add_bcc(self, bcc: impl Into<Address>) -> Self

Append a recipient to the Bcc list.

pub fn reply_to<I>(self, reply_to: I) -> Self

where I: IntoIterator<Item = Address>,

Replace the entire Reply-To list.

pub fn add_reply_to(self, reply_to: impl Into<Address>) -> Self

Append a recipient to the Reply-To list.

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

pub const fn date(self, date: OffsetDateTime) -> Self

pub fn message_id(self, message_id: MessageId) -> Self

pub fn headers<I>(self, headers: I) -> Self

where I: IntoIterator<Item = Header>,

pub fn add_header(self, header: Header) -> Self

Append a single custom header.

pub fn attachments<I>(self, attachments: I) -> Self

where I: IntoIterator<Item = Attachment>,

pub fn add_attachment(self, attachment: Attachment) -> Self

Append a single attachment.

pub fn build_unchecked(self) -> Message

Returns the underlying Message without running outbound validation.

Reserved for paths that construct a Message from already-parsed inbound data, for example email_message_wire::parse_rfc822, where the wire-format invariants come from the parser and the outbound rules (From set, at least one recipient, no reserved header collisions, no CRLF in subject) are not meaningful.

Outbound callers should use Self::build or Self::build_outbound instead. Wrapping the result of build_unchecked in OutboundMessage::new re-runs the validation you skipped, with no benefit.

pub fn build(self) -> Result<Message, MessageValidationError>

Build and validate the message.

Errors

Returns MessageValidationError when required message fields are missing or inconsistent.

pub fn build_outbound(self) -> Result<OutboundMessage, MessageValidationError>

Build, validate, and wrap the message for outbound delivery.

Errors

Returns MessageValidationError when required message fields are missing or inconsistent.

Trait Implementations

impl Clone for MessageBuilder

fn clone(&self) -> MessageBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageBuilder

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

Formats the value using the given formatter.

impl PartialEq for MessageBuilder

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

impl StructuralPartialEq for MessageBuilder