pub struct Email {
pub to: Vec<String>,
pub from: Option<String>,
pub reply_to: Option<String>,
pub cc: Vec<String>,
pub bcc: Vec<String>,
pub subject: Option<String>,
pub text: Option<String>,
pub html: Option<String>,
pub headers: Vec<(String, String)>,
}Expand description
An email message
Use the builder pattern to construct emails:
use acton_htmx::email::Email;
let email = Email::new()
.to("user@example.com")
.from("noreply@myapp.com")
.subject("Welcome!")
.text("Welcome to our app!")
.html("<h1>Welcome to our app!</h1>");Fields§
§to: Vec<String>Email recipients (To)
from: Option<String>Email sender (From)
reply_to: Option<String>Reply-To address
cc: Vec<String>CC recipients
bcc: Vec<String>BCC recipients
subject: Option<String>Email subject
text: Option<String>Plain text body
html: Option<String>HTML body
headers: Vec<(String, String)>Custom headers
Implementations§
Source§impl Email
impl Email
Sourcepub fn from_template<T: EmailTemplate>(template: &T) -> Result<Self, EmailError>
pub fn from_template<T: EmailTemplate>(template: &T) -> Result<Self, EmailError>
Create an email from a template
§Errors
Returns EmailError::TemplateError if the template fails to render
§Examples
use acton_htmx::email::{Email, EmailTemplate};
use askama::Template;
#[derive(Template)]
#[template(path = "emails/welcome.html")]
struct WelcomeEmail {
name: String,
}
let template = WelcomeEmail {
name: "Alice".to_string(),
};
let email = Email::from_template(&template)?;Sourcepub fn to(self, address: &str) -> Self
pub fn to(self, address: &str) -> Self
Add a recipient (To)
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.to("user@example.com");Sourcepub fn to_multiple(self, addresses: &[&str]) -> Self
pub fn to_multiple(self, addresses: &[&str]) -> Self
Add multiple recipients (To)
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.to_multiple(&["user1@example.com", "user2@example.com"]);Sourcepub fn from(self, address: &str) -> Self
pub fn from(self, address: &str) -> Self
Set the sender (From)
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.from("noreply@myapp.com");Sourcepub fn reply_to(self, address: &str) -> Self
pub fn reply_to(self, address: &str) -> Self
Set the reply-to address
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.reply_to("support@myapp.com");Sourcepub fn cc(self, address: &str) -> Self
pub fn cc(self, address: &str) -> Self
Add a CC recipient
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.cc("manager@example.com");Sourcepub fn bcc(self, address: &str) -> Self
pub fn bcc(self, address: &str) -> Self
Add a BCC recipient
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.bcc("admin@example.com");Sourcepub fn subject(self, subject: &str) -> Self
pub fn subject(self, subject: &str) -> Self
Set the email subject
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.subject("Welcome to Our App!");Sourcepub fn text(self, body: &str) -> Self
pub fn text(self, body: &str) -> Self
Set the plain text body
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.text("Welcome to our app!");Sourcepub fn html(self, body: &str) -> Self
pub fn html(self, body: &str) -> Self
Set the HTML body
§Examples
use acton_htmx::email::Email;
let email = Email::new()
.html("<h1>Welcome to our app!</h1>");Trait Implementations§
Source§impl<'de> Deserialize<'de> for Email
impl<'de> Deserialize<'de> for Email
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for Email
impl RefUnwindSafe for Email
impl Send for Email
impl Sync for Email
impl Unpin for Email
impl UnwindSafe for Email
Blanket Implementations§
Source§impl<T> ActonMessage for T
impl<T> ActonMessage for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian().