IEmailVerifier
in
Email verification service interface
Table of Contents
Methods
- cleanupExpiredTokens() : int
- Clean up expired email verification tokens
- resendVerification() : bool
- Resend verification email to a user
- sendVerificationEmail() : bool
- Send verification email to user
- setTokenExpirationMinutes() : self
- Set token expiration time in minutes
- validateToken() : EmailVerificationToken|null
- Validate an email verification token
- verifyEmail() : bool
- Verify a user's email using a token
Methods
cleanupExpiredTokens()
Clean up expired email verification tokens
public
cleanupExpiredTokens() : int
Return values
int —Number of tokens deleted
resendVerification()
Resend verification email to a user
public
resendVerification(string $email) : bool
Parameters
- $email : string
-
User's email address
Return values
bool —True on success
sendVerificationEmail()
Send verification email to user
public
sendVerificationEmail(User $user) : bool
Parameters
- $user : User
-
User to send email to
Return values
bool —True on success
setTokenExpirationMinutes()
Set token expiration time in minutes
public
setTokenExpirationMinutes(int $minutes) : self
Parameters
- $minutes : int
-
Expiration time in minutes
Return values
selfvalidateToken()
Validate an email verification token
public
validateToken(string $plainToken) : EmailVerificationToken|null
Parameters
- $plainToken : string
-
The plain token string
Return values
EmailVerificationToken|null —Token object if valid, null otherwise
verifyEmail()
Verify a user's email using a token
public
verifyEmail(string $plainToken) : bool
Parameters
- $plainToken : string
-
The plain token string
Return values
bool —True on success