Skip to main content

EmailApi

Struct EmailApi 

Source
pub struct EmailApi { /* private fields */ }
Expand description

Email API facade — typed API in [KernelHandle].

Constructed during kernel assembly (only when [email] is configured) and stored in KernelHandle.email.

Implementations§

Source§

impl EmailApi

Source

pub fn new( smtp: SmtpClient, template_dir: PathBuf, state_store: Arc<StateStore>, event_bus: Option<EventBus>, rate_limit: usize, ) -> Self

Create a new EmailApi.

Source

pub async fn send( &self, subject: &str, html: &str, text: Option<&str>, ) -> Result<SendReceipt>

Send an email (delegated to SmtpClient).

Source

pub async fn test_connection(&self) -> Result<()>

Test the SMTP connection.

Source

pub fn default_to(&self) -> &str

The default recipient address (user’s own email).

Source

pub fn from_addr(&self) -> &str

The sender address.

Source

pub fn load_template(&self, name: &str) -> Result<String>

Load a template by name.

Templates are stored as email_templates/<name>.html.

Source

pub fn save_template(&self, name: &str, html: &str) -> Result<()>

Save a template.

Source

pub fn list_templates(&self) -> Result<Vec<String>>

List all available template names.

Source

pub async fn save_sent_record<T: Serialize>(&self, record: &T) -> Result<()>

Save a sent email record to the state store.

Filename format: {timestamp}_{short_id}.json for rate-limit parsing.

Source

pub async fn count_recent_sent(&self, hours: u64) -> Result<usize>

Count emails sent in the last hours hours (for rate limiting).

Expects filenames: YYYYMMDD_HHMMSS_shortid.json

Source

pub fn notify_sent( &self, subject: String, message_id: String, template_name: Option<String>, )

Publish an EmailSent event to the event bus.

Source

pub fn rate_limit(&self) -> usize

Rate limit (emails per hour).

Trait Implementations§

Source§

impl Clone for EmailApi

Source§

fn clone(&self) -> EmailApi

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 EmailApi

Source§

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

Formats the value using the given formatter. Read more

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