Struct EmailVerificationPlugin 

pub struct EmailVerificationPlugin { /* private fields */ }

Email verification plugin for handling email verification flows

Implementations

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 auto_verify_new_users(self, val: bool) -> Self

pub fn send_on_sign_in(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 verification_token_expiry_hours(self, hours: i64) -> Self

Backward-compatible builder: set token expiry in hours.

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

impl EmailVerificationPlugin

pub async fn send_verification_on_sign_in<DB: DatabaseAdapter>( &self, user: &DB::User, callback_url: Option<&str>, ctx: &AuthContext<DB>, ) -> 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 async 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<DB: DatabaseAdapter> AuthPlugin<DB> 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<DB>, ) -> 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 on_user_created<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, user: &'life1 DB::User, ctx: &'life2 AuthContext<DB>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

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

Called after a user is created

fn on_init<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut AuthContext<DB>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

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

Called when the plugin is initialized

fn before_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<DB>, ) -> 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 before route matching for every incoming request.

fn on_session_created<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session: &'life1 <DB as SessionOps>::Session, ctx: &'life2 AuthContext<DB>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

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

Called after a session is created

fn on_user_deleted<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, user_id: &'life1 str, ctx: &'life2 AuthContext<DB>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

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

Called before a user is deleted

fn on_session_deleted<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session_token: &'life1 str, ctx: &'life2 AuthContext<DB>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

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

Called before a session is deleted

impl Default for EmailVerificationPlugin

fn default() -> Self

Returns the “default value” for a type.