Struct EmailVerificationPlugin 

pub struct EmailVerificationPlugin { /* private fields */ }

Email verification plugin for handling email verification flows

Implementations

impl EmailVerificationPlugin

pub fn callbacks<S: AuthSchema>( self, callbacks: EmailVerificationCallbacks<S>, ) -> impl AuthPlugin<S>

Attach typed delivery callbacks after configuring the verification options.

impl EmailVerificationPlugin

pub fn new() -> Self

pub fn with_config(config: EmailVerificationConfig) -> Self

pub fn verification_token_expiry(self, val: Duration) -> Self

pub fn send_email_notifications(self, val: bool) -> Self

pub fn require_verification_for_signin(self, val: bool) -> Self

pub fn send_on_sign_in(self, val: bool) -> Self

pub fn send_on_sign_up(self, val: bool) -> Self

pub fn auto_sign_in_after_verification(self, val: bool) -> Self

pub fn before_email_verification(self, val: EmailVerificationHook) -> Self

pub fn after_email_verification(self, val: EmailVerificationHook) -> Self

impl EmailVerificationPlugin

pub fn custom_send_verification_email( self, sender: Arc<dyn SendVerificationEmail>, ) -> Self

impl EmailVerificationPlugin

pub async fn send_verification_on_sign_in( &self, user: &impl AuthUser, callback_url: Option<&str>, ctx: &AuthContext<impl AuthSchema>, ) -> AuthResult<()>

Send a verification email on sign-in for an unverified user.

Callers (e.g. the sign-in plugin) should invoke this when EmailVerificationConfig::send_on_sign_in is true and the user is not yet verified.

pub fn should_send_on_sign_in(&self) -> bool

Check if send_on_sign_in is enabled.

pub fn is_verification_required(&self) -> bool

Check if email verification is required for signin

pub fn is_user_verified_or_not_required(&self, user: &impl AuthUser) -> bool

Check if user is verified or verification is not required

Trait Implementations

impl<S: AuthSchema> AuthPlugin<S> for EmailVerificationPlugin

fn name(&self) -> &'static str

Plugin name - should be unique

fn routes(&self) -> Vec<AuthRoute>

Routes that this plugin handles

fn on_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<Option<AuthResponse>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each request - return Some(response) to handle, None to pass through

fn telemetry_plugin_id(&self) -> Option<&'static str>

Return the upstream plugin ID; core option wrappers have no plugin ID.

fn telemetry(&self, options: &mut PluginTelemetry)

Report configured options without invoking callbacks or initializing the plugin.

fn on_init<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut AuthInitContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the plugin is initialized

fn openapi(&self) -> Result<OpenApiPluginMetadata, AuthError>

Document this configured plugin without invoking application field policies.

fn password_hasher(&self) -> Option<Arc<dyn PasswordHasher>>

Select the base password hasher before plugin initialization wraps it.

fn rate_limits(&self) -> Result<Vec<PluginRateLimit>, AuthError>

Default endpoint limits, overridden by explicit application limits.

fn on_http_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Inspect an HTTP request after rate limiting and before endpoint middleware. Native API calls do not run this hook. A response skips endpoint hooks.

fn on_http_response<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Inspect the HTTP router response, including route misses and body errors. Early HTTP request responses and native endpoint calls skip this hook. A replacement response stops the remaining HTTP response hooks.

fn before_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<BeforeRequestAction>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Called for a registered endpoint after HTTP body decoding and origin checks.

fn after_request<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Inspect or extend the final route response after session cookies are applied.

impl Default for EmailVerificationPlugin

fn default() -> Self

Returns the “default value” for a type.