Skip to main content

Mail

Struct Mail 

Source
#[non_exhaustive]
pub struct Mail { pub to: Vec<String>, pub subject: String, pub text: String, pub html: Option<String>, pub cc: Vec<String>, pub bcc: Vec<String>, pub reply_to: Option<String>, pub from: Option<String>, pub attachments: Vec<Attachment>, }
Expand description

One email message. html is optional; text is always sent.

let pdf: Vec<u8> = b"%PDF-1.7 ...".to_vec();
let mail = Mail::new("ben@example.com", "Invoice INV-001", "Your invoice is attached.")
    .also_to("finance@example.com")
    .cc("sales@example.com")
    .bcc("archive@example.com")
    .reply_to("Coffee Shop <hello@shop.example>")
    .from("Coffee Shop Billing <billing@shop.example>") // instead of MAIL_FROM_*
    .attach("INV-001.pdf", "application/pdf", pdf);

Addresses are a@b.c or Name <a@b.c>; an invalid one fails the send (and a queued mail isn’t retried for it).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§to: Vec<String>

Recipients.

§subject: String

The subject line.

§text: String

The plain-text body.

§html: Option<String>

An HTML body, sent next to text when set.

§cc: Vec<String>

Carbon-copy recipients.

§bcc: Vec<String>

Blind-carbon-copy recipients.

§reply_to: Option<String>

The address replies go to.

§from: Option<String>

Sender instead of MAIL_FROM_ADDRESS / MAIL_FROM_NAME.

§attachments: Vec<Attachment>

Files sent with the mail.

Implementations§

Source§

impl Mail

Source

pub fn new( to: impl Into<String>, subject: impl Into<String>, text: impl Into<String>, ) -> Self

A mail to to with this subject and plain-text body.

Source

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

Adds an HTML body; text is still sent as the plain alternative.

Source

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

Another recipient.

Source

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

Adds a carbon-copy recipient.

Source

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

Adds a blind-carbon-copy recipient.

Source

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

Where replies go.

Source

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

Sends as address instead of MAIL_FROM_ADDRESS / MAIL_FROM_NAME.

Source

pub fn attach( self, filename: impl Into<String>, content_type: impl Into<String>, data: impl Into<Vec<u8>>, ) -> Self

Attaches data as a file named filename of type content_type.

Source

pub fn is_for(&self, address: &str) -> bool

Whether address is among to, cc or bcc.

Trait Implementations§

Source§

impl Clone for Mail

Source§

fn clone(&self) -> Self

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 Mail

Source§

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

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

impl<'de> Deserialize<'de> for Mail

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 PartialEq for Mail

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Mail

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 StructuralPartialEq for Mail

Auto Trait Implementations§

§

impl Freeze for Mail

§

impl RefUnwindSafe for Mail

§

impl Send for Mail

§

impl Sync for Mail

§

impl Unpin for Mail

§

impl UnsafeUnpin for Mail

§

impl UnwindSafe for Mail

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Fake for T

Source§

fn fake<U>(&self) -> U
where Self: FakeBase<U>,

Source§

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U
where R: RngExt + ?Sized, Self: FakeBase<U>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more