Struct MessageBuilder

Source

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

Expand description

Builder for Message.

Implementations§

Source §

impl MessageBuilder

Source

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

Creates a builder with the required message body.

Source

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.

Source

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

Sets the optional Sender mailbox.

Source

pub fn to(self, to: I) -> Self
where I: IntoIterator<Item = Address>,

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

Source

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

Append a recipient to the To list.

Source

pub fn cc(self, cc: I) -> Self
where I: IntoIterator<Item = Address>,

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

Source

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

Append a recipient to the Cc list.

Source

pub fn bcc(self, bcc: I) -> Self
where I: IntoIterator<Item = Address>,

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

Source

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

Append a recipient to the Bcc list.

Source

pub fn reply_to(self, reply_to: I) -> Self
where I: IntoIterator<Item = Address>,

Replace the entire Reply-To list.

Source

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

Append a recipient to the Reply-To list.

Source

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

Sets the optional subject.

Source

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

Sets the optional message date.

Source

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

Sets the optional message id.

Source

pub fn headers(self, headers: I) -> Self
where I: IntoIterator<Item = Header>,

Replaces all custom headers.

Source

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

Append a single custom header.

Source

pub fn attachments(self, attachments: I) -> Self
where I: IntoIterator<Item = Attachment>,

Replaces all attachments.

Source

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

Append a single attachment.

Source

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.

Source