Struct EmailVerificationPlugin 

pub struct EmailVerificationPlugin { /* private fields */ }

Email verification plugin for handling email verification flows

Implementations

impl EmailVerificationPlugin

pub fn new() -> EmailVerificationPlugin

pub fn with_config(config: EmailVerificationConfig) -> EmailVerificationPlugin

pub fn verification_token_expiry_hours( self, hours: i64, ) -> EmailVerificationPlugin

pub fn send_email_notifications(self, send: bool) -> EmailVerificationPlugin

pub fn require_verification_for_signin( self, require: bool, ) -> EmailVerificationPlugin

pub fn auto_verify_new_users(self, auto_verify: bool) -> EmailVerificationPlugin

impl EmailVerificationPlugin

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> AuthPlugin<DB> for EmailVerificationPlugin

where DB: DatabaseAdapter,

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 = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, EmailVerificationPlugin: '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 as DatabaseAdapter>::User, ctx: &'life2 AuthContext<DB>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, EmailVerificationPlugin: '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 on_session_created<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session: &'life1 <DB as DatabaseAdapter>::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() -> EmailVerificationPlugin

Returns the “default value” for a type.