Skip to main content

Message

Struct Message 

Source
#[non_exhaustive]
pub struct Message { /* private fields */ }
Expand description

Parsed message content and headers.

§Validation

Message validation is split between this crate and the wire layer:

  • Message::validate_basic enforces structural invariants: From is set, Sender is not set without From, at least one recipient in To/Cc/Bcc, the subject contains no raw \r, \n, or non-tab control characters, and no custom header collides with a structured field (Subject, Message-ID, …).
  • Per-field RFC 5322 invariants (line length, RFC 2047 encoded-word wrapping, ASCII-after-encoding, header folding) are enforced by email_message_wire::render_rfc822 for SMTP paths.
  • HTTP-API adapters (Postmark, Resend, Mailgun, Loops) bypass the wire renderer and rely on serde_json string-escaping for control-char neutralization in JSON bodies.

Adapters that bypass both the wire renderer and a JSON-encoded transport must validate header values themselves.

Implementations§

Source§

impl Message

Source

pub const fn new(from: Mailbox, to: Vec<Address>, body: Body) -> Self

Creates a message with required semantic fields.

Source

pub const fn builder(body: Body) -> MessageBuilder

Returns a builder for incrementally constructing messages.

Source

pub const fn from_mailbox(&self) -> Option<&Mailbox>

Returns the optional From mailbox, if one has been set.

OutboundMessage validation guarantees From is present; for already-validated messages, prefer OutboundMessage::from_mailbox which returns &Mailbox directly.

Source

pub const fn sender(&self) -> Option<&Mailbox>

Source

pub fn to(&self) -> &[Address]

Source

pub fn cc(&self) -> &[Address]

Source

pub fn bcc(&self) -> &[Address]

Source

pub fn reply_to(&self) -> &[Address]

Source

pub fn subject(&self) -> Option<&str>

Source

pub const fn date(&self) -> Option<&OffsetDateTime>

Source

pub const fn message_id(&self) -> Option<&MessageId>

Source

pub fn headers(&self) -> &[Header]

Source

pub const fn body(&self) -> &Body

Source

pub fn attachments(&self) -> &[Attachment]

Source

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

Source

pub fn into_attachments(self) -> (Self, Vec<Attachment>)

Split the message into an attachment-free message and its attachments.

Source

pub fn validate_basic(&self) -> Result<(), MessageValidationError>

Validates baseline message invariants.

§Coverage

The gate covers top-level message fields (from, sender, recipients, subject, custom headers) and the attachments list (filename and content-id byte discipline). It does not recurse into Body::Mime payloads: MIME-tree fields the typed wrappers leave unvalidated at construction (notably MimePart::Multipart’s boundary: Option<String>, which is lazy-checked by the wire renderer’s validate_boundary at render time, and MimePart::Leaf’s raw body: Vec<u8>, which is transfer-encoded at render time) are not inspected here. Such bytes are caught by the wire renderer at email_message_wire::render_rfc822’s header-emission and boundary-validation stages, which reject raw CR/LF and non-ASCII at write time. Walking the entire MimePart tree in this method would make the gate quadratic on attacker-controlled depth, the inverse of the renderer’s own MAX_MULTIPART_DEPTH cap.

§Errors

Returns MessageValidationError when required message fields are missing or inconsistent.

Source

pub fn derive_envelope(&self) -> Result<Envelope, MessageValidationError>

Derives an SMTP envelope from message semantics.

§Errors

Returns MessageValidationError when the message does not contain the fields needed to derive an envelope.

Trait Implementations§

Source§

impl<'a> Arbitrary<'a> for Message

Available on crate feature arbitrary only.
Source§

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data. Read more
Source§

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more
Source§

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
Source§

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more
Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Message

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<OutboundMessage> for Message

Source§

fn from(value: OutboundMessage) -> Self

Converts to this type from the input type.
Source§

impl JsonSchema for Message

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for Message

Source§

fn eq(&self, other: &Message) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Message

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<Message> for OutboundMessage

Source§

type Error = MessageValidationError

The type returned in the event of a conversion error.
Source§

fn try_from(value: Message) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Eq for Message

Source§

impl StructuralPartialEq for Message

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,