Skip to main content

Reply

Struct Reply 

Source
pub struct Reply {
    pub code: u16,
    pub lines: Vec<String>,
    /* private fields */
}
Expand description

A complete SMTP reply, possibly assembled from multiple continuation lines.

Fields§

§code: u16

The three-digit reply code, shared by every line of the reply.

§lines: Vec<String>

One entry per line, in the order received. Each entry is the line’s text portion (after the code and separator) decoded as UTF-8 with invalid sequences replaced by U+FFFD. The text retains any enhanced status code prefix; use Self::message_text to obtain the same text with the prefix stripped, or Self::enhanced to obtain the parsed code itself.

Implementations§

Source§

impl Reply

Source

pub fn new(code: u16, lines: Vec<String>) -> Self

Construct a reply with the given code and lines, with no enhanced status code attached. The client adds an enhanced code via the internal attach_enhanced_status setter when the session has ENHANCEDSTATUSCODES enabled.

Source

pub fn class(&self) -> u8

The leading digit of the reply code, useful for class-based checks.

Source

pub fn joined_text(&self) -> String

Reply text concatenated with \n. Suitable for diagnostics. If an enhanced status code prefix is present, it is preserved in the output; use Self::message_text for a presentation that hides it.

§Caveat for log handlers

The returned String may contain \n (used internally to separate multi-line replies). It does not contain \r — CRLF is stripped by the reply parser before storage — but applications that forward this text to line-oriented loggers (syslog, journald, structured JSON, etc.) should still escape or render newlines explicitly to avoid log injection where one logical reply renders as multiple log records. The same caveat applies to anything else that consumes the Display output of crate::ProtocolError or crate::AuthError, since those types embed reply text.

Source

pub fn message_text(&self) -> String

Reply text with any enhanced status code prefix stripped from each line. Suitable for human-facing error messages where the code is shown separately. Lines that have no enhanced prefix are returned unchanged.

Source

pub fn enhanced(&self) -> Option<EnhancedStatus>

Parsed enhanced status code, if the server has provided one and the session has it enabled.

Source

pub fn iter_lines(&self) -> impl Iterator<Item = &str>

Iterate over the trimmed text of each line. Useful for parsing EHLO capabilities, where the first line contains the greeting and the remaining lines each name a single capability (e.g. AUTH LOGIN, PIPELINING, 8BITMIME).

Source

pub fn try_parse_enhanced(&self) -> Option<EnhancedStatus>

Parse an enhanced status code from the first line’s text, if present. Used by the client to populate self.enhanced only when the session has ENHANCEDSTATUSCODES enabled.

Trait Implementations§

Source§

impl Clone for Reply

Source§

fn clone(&self) -> Reply

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Reply

Source§

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

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

impl PartialEq for Reply

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Eq for Reply

Source§

impl StructuralPartialEq for Reply

Auto Trait Implementations§

§

impl Freeze for Reply

§

impl RefUnwindSafe for Reply

§

impl Send for Reply

§

impl Sync for Reply

§

impl Unpin for Reply

§

impl UnsafeUnpin for Reply

§

impl UnwindSafe for Reply

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> 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> Same for T

Source§

type Output = T

Should always be Self
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.