Skip to main content

Module email_otp

Module email_otp 

Source
Expand description

Passwordless email authentication and verification using single-use codes.

EmailOtpPlugin::create_verification_otp and EmailOtpPlugin::get_verification_otp are server-only operations. Neither operation registers an HTTP endpoint.

Structs§

EmailOtpChangeInput
New mailbox and its scoped change proof.
EmailOtpChangeRequestInput
New mailbox and optional proof of the current mailbox.
EmailOtpChangeRequested
The change challenge was delivered or an existing target mailbox was concealed.
EmailOtpChanged
The caller’s verified mailbox was changed while retaining session authority.
EmailOtpCheck
A successful check retains the proof and its current attempt count.
EmailOtpConfig
Configuration for email OTP verification, login, password reset and email change.
EmailOtpDelivery
Delivery data. Debug intentionally omits the authentication secret.
EmailOtpPasswordReset
A replacement credential was committed without issuing browser authority.
EmailOtpPasswordResetInput
Scoped reset proof and replacement credential for the public server operation.
EmailOtpPlugin
EmailOtpRead
EmailOtpResetRequested
Reset request aliases acknowledge delivered or concealed mailbox requests.
EmailOtpSent
The sending operation acknowledges both delivery and concealed unknown mailboxes.
EmailOtpSignInInput
Sign-in credentials with schema-defined fields retained for new identities.
EmailOtpSignInResult
Authority published after consuming a sign-in proof.
EmailOtpVerification
A verified mailbox with optional newly issued browser authority.

Enums§

EmailOtpStorage
EmailOtpType
Code scope. Codes issued for one operation cannot authorize another.
OtpResendStrategy

Traits§

EmailOtpCodec
Application-owned codec for custom hash/encryption storage. retrieve returns None when the representation is intentionally irreversible.
EmailOtpGenerator
Optional application code generator. Returning None selects the default cryptographically random numeric generator.
SendEmailOtp
Delivers a code to its intended mailbox with the real native callback context. Delivery awaits and propagates errors by default; configured background work owns its context and logs failures while retaining the issued verification.