Skip to main content

EmailOtpConfig

better_auth_api::plugins::email_otp

Struct EmailOtpConfig

pub struct EmailOtpConfig {Show 14 fields
    pub sender: Option<Arc<dyn SendEmailOtp>>,
    pub otp_length: usize,
    pub expires_in: Duration,
    pub allowed_attempts: u32,
    pub disable_sign_up: bool,
    pub change_email: bool,
    pub verify_current_email: bool,
    pub reuse_otp: bool,
    pub storage: EmailOtpStorage,
    pub generate_otp: Option<EmailOtpGenerator>,
    pub send_verification_on_sign_up: bool,
    pub override_default_email_verification: bool,
    pub rate_limit_window: f64,
    pub rate_limit_max: f64,
}

Expand description

Options for email OTP routes.

Fields§

§sender: Option<Arc<dyn SendEmailOtp>>

OTP delivery callback; requests fail when no sender is configured.

§otp_length: usize

Number of decimal digits in a generated OTP. Default: 6.

§expires_in: Duration

OTP validity and resend extension. Default: 5 minutes.

§allowed_attempts: u32

Failed code attempts before the next check locks the code. Zero means 3.

§disable_sign_up: bool

Prevent email OTP from creating a new user.

§change_email: bool

Enable authenticated email changes.

§verify_current_email: bool

Require the current mailbox’s verification OTP before email changes.

§reuse_otp: bool

Reuse a valid recoverable code and extend its expiry on resend.

§storage: EmailOtpStorage

Stored code protection. Default: plain.

§generate_otp: Option<EmailOtpGenerator>

Generate a custom OTP. Empty output uses the decimal generator.

§send_verification_on_sign_up: bool

Send a verification OTP after successful sign-up.

§override_default_email_verification: bool

Replace default email verification messages with OTP delivery.

§rate_limit_window: f64

Endpoint rate limit window. Zero means 60 seconds.

§rate_limit_max: f64

Endpoint rate limit maximum. Zero means 3.

Trait Implementations§

impl Clone for EmailOtpConfig

fn clone(&self) -> Self

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

impl Default for EmailOtpConfig

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for EmailOtpConfig

impl !UnwindSafe for EmailOtpConfig

impl Freeze for EmailOtpConfig

impl Send for EmailOtpConfig

impl Sync for EmailOtpConfig

impl Unpin for EmailOtpConfig

impl UnsafeUnpin for EmailOtpConfig

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more