Neuron-PHP

IEmailVerificationService

Email verification service interface

Table of Contents

Methods

canRequestVerification()  : bool
Check if user can request verification email (rate limiting)
getTimeUntilNextRequest()  : int
Get time until user can request verification again
sendVerificationEmail()  : bool
Send verification email to user
verifyEmail()  : bool
Verify user's email using token

Methods

canRequestVerification()

Check if user can request verification email (rate limiting)

public canRequestVerification(int $userId) : bool
Parameters
$userId : int
Return values
bool

True if user can request

getTimeUntilNextRequest()

Get time until user can request verification again

public getTimeUntilNextRequest(int $userId) : int
Parameters
$userId : int
Return values
int

Seconds until next request allowed

sendVerificationEmail()

Send verification email to user

public sendVerificationEmail(User $user) : bool
Parameters
$user : User
Tags
throws
Exception
Return values
bool

True if email sent successfully

verifyEmail()

Verify user's email using token

public verifyEmail(string $token) : bool
Parameters
$token : string
Tags
throws
Exception
Return values
bool

True if verification successful


        
On this page

Search results