This content originally appeared on DEV Community and was authored by Denys
mail verification is the process of ensuring an email address exists and can receive emails. Whereas, email validation checks if the address is properly formatted; that is - written according to specific standards (e.g. UTF-8).
In this article, I’ll talk about PHP email verification and how to use it for web development and user authentication via a verification token. The article involves a few micro tutorials, including:
PHPMailer configuration with Mailtrap
A simple HTML form creation
Basic email address verification
Generating and storing tokens and credentials in an SQL database
Sending email verification with a verification token
Email testing as related to verification
So, let’s get to it.
Setting up email sending
To send verification emails, you can use PHP's built-in mail() function or a library like PHPMailer, which offers more features and better reliability.
Since I want to make the tutorial as safe and production-ready as possible, I’ll be using ‘PHPMailer’. Check the code to install PHPMailer via Composer:
composer require phpmailer/phpmailer
Why use Mailtrap API/SMTP?
It’s an email delivery platform to test, send, and control your emails in one place. And, among other things, you get the following:
Ready-made configuration settings for various languages, PHP & Laravel included.
SMTP and API with SDKs in major languages, ofc, PHP included.
Industry-best analytics.
27/7 Human support, and fast track procedure for urgent cases.
All that allows you to bootstrap the email verification process, and keep it safe and stable for all.
Moving on to the settings to configure PHPMailer with Mailtrap:
$phpmailer = new PHPMailer();
$phpmailer->isSMTP();
$phpmailer->Host = 'live.smtp.mailtrap.io';
$phpmailer->SMTPAuth = true;
$phpmailer->Port = 587;
$phpmailer->Username = 'api';
$phpmailer->Password = 'YOUR_MAILTRAP_PASSWORD';
Here’s the PHPMailer setup:
use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\PHPMailer\Exception;
require 'vendor/autoload.php';
function sendVerificationEmail($email, $verificationCode) {
$mail = new PHPMailer(true);
try {
// Server settings
$mail->isSMTP();
$mail->Host = 'live.smtp.mailtrap.io';
$mail->SMTPAuth = true;
$mail->Username = 'api';
$mail->Password = 'YOUR_MAILTRAP_PASSWORD';
$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;
$mail->Port = 587;
// Recipients
$mail->setFrom('youremail@example.com', 'Your Website');
$mail->addAddress($email);
// Content
$mail->isHTML(false);
$mail->Subject = 'Email Verification';
$mail->Body = "Your verification code is: $verificationCode";
$mail->send();
return true;
} catch (Exception $e) {
return false;
}
}
Note that the code above doesn’t send the verification token (click here to jump to the code snippet with the verification token). It’s only an example of how to set up Mailtrap SMTP and define the verification function. Here’s a quick breakdown of key points:
PHPMailer and Exception classes get imported.
sendVerificationEmail($email, $verificationCode) is the function definition.
A new PHPMailer object is created.
The try-catch block handles exceptions during email sending.
The server settings are set to Mailtrap as per the exemplary configuration.
The email content is set to isHTML(false) for plain text.
Tips:
The email content can be refactored to HTML.
Due to throughput limitations, you should avoid using gmail.com as a signup form SMTP relay. But if you really want to create a mailer PHP file and send via Gmail, check this tutorial.
Creating a registration form
The below is a simple registration form, it contains the header and user account information (username, email, and password).
It doesn’t have any CSS stylesheet or div class since this is only an example.
However, I’d advise you to include these on production and align them with the design language of your brand. Otherwise, your form may look unprofessional and users would be reluctant to engage with it.
<!DOCTYPE html>
<html>
<head>
<title>Register</title>
</head>
<body>
<form action="register.php" method="post">
<label>Username:</label>
<input type="text" name="username" required>
<br>
<label>Email:</label>
<input type="email" name="email" required>
<br>
<label>Password:</label>
<input type="password" name="password" required>
<br>
<input type="submit" name="register" value="Register">
</form>
</body>
</html>
Bonus Pro Tip - Consider using JavaScript with your forms
If you want a full tutorial on how to create a PHP contact form that includes reCaptcha, check the video below ⬇️.
JS can validate user input in real time, providing immediate feedback on errors without needing to reload the page.
By catching errors on the client side, JS can reduce the number of invalid requests sent to the server, thereby reducing server load and improving performance for each session.
Using AJAX, JS can send and receive data from the server without reloading the page, providing a smoother user experience.
Now, I’ll move to email address verification.
Email address verification
Here’s a simple script to check for the domain and the MX record. It basically allows you to verify email by performing an MX lookup.
<?php
// This method checks if the domain part of the email address has a functioning mail server.
$email = "user@example.com";
list($user, $domain) = explode(separator:"@", $email)
if (filter_var($email, filter:FILTER_VALIDATE_EMAIL) && getmxrr($domain, &hosts: $mxhosts)){
echo "Valid email address with a valid mail server" . PHP_EOL;
} else {
echo "Invalid email address or no valid mail server found" . PHP_EOL;
}
However, the script doesn’t send email for user activation and authentication. Also, it doesn’t store any data in MySQL.
For that, I’ll do the following in the next sections:
Generate a verification token
Create a PHP MySQL schema to store the credentials from the registration form
Send the verification email with the token
Verify the verification token
Tip: Similar logic can be applied to a logout/login form.
Generating verification token
A verification token is a unique string generated for each user during registration. This token is included in the verification email and there are two methods to generate it.
Method 1
The first method leverages the bin2hex command to create a random token with the parameter set to (random_bytes(50)).
$token = bin2hex(random_bytes(50));
Method 2
Alternatively, you can generate the token with the script below. And I’ll be using that script in the email-sending script.
<?php
function generateVerificationCode($length = 6) {
$characters = '0123456789';
$code = '';
for ($i = 0; $i < $length; $i++) {
$code .= $characters[rand(0, strlen($characters) - 1)];
}
return $code;
}
?>
Storing verification token
Before sending the verification email, it’s vital to ensure you properly handle and store user data. I’ll use a simple SQL schema to create the users table and store the generated token in the database along with the user's registration information.
CREATE TABLE users (
id INT AUTO_INCREMENT PRIMARY KEY,
username VARCHAR(50) NOT NULL,
email VARCHAR(100) NOT NULL,
password VARCHAR(255) NOT NULL,
token VARCHAR(255) DEFAULT NULL,
is_verified TINYINT(1) DEFAULT 0
);
Quick breakdown:
The script above creates a users table with the following columns:
id - Unique identifier for each user, automatically incremented.
username - The user's username; it cannot be null.
email - The user's email address; it cannot be null.
password - The user's password (hashed); it cannot be null.
token - A verification token, which can be null.
is_verified - A flag indicating whether the user is verified (0 for not verified, 1 for verified), with a default value of 0.
Sending verification token
Overall, the script below is amalgamation of everything previously discussed in the article and it’s designed to:
Generate a random numeric verification code.
Send the verification email to a specified email address using PHPMailer.
Configure the email server settings.
Handle potential errors.
Provide feedback on whether the email was successfully sent.
Note that the script is geared towards Mailtrap users and it leverages the SMTP method.
<?php
require 'vendor/autoload.php';
use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\PHPMailer\SMTP
use PHPMailer\PHPMailer\Exception;
//Function to generate a random verification code
1 usage
function generateVerificationCode($length = 6) {
$characters = '0123456789';
$code = '';
for ($i = 0; $i < $length; $i++) {
$code .= $characters[rand(0, strlen($characters) - 1)];
}
return $code;
}
// Function to send a verification email using PHPMailer
1 usage
function sendVerificationEmail($email, $verificationCode) {
$mail = new PHPMailer (exception: true);
try {
// Server settings
$mail ->SMTPDebug = SMTP::DEBUG_OFF; // Set to DEBUG_SERVER for debugging
$mail ->isSMTP();
$mail ->Host = 'live.smtp.mailtrap.io'; // Mailtrap SMTP server host
$mail ->SMTPAuth = true;
$mail ->Username = 'api'; // Your Mailtrap SMTP username
$mail ->Password = 'YOUR_MAILTRAP_PASSWORD'; // Your Mailtrap SMTP password
$mail ->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS; // Enable TLS encryption
$email ->Port = 587; // TCP port to connect to
//Recipients
$mail->setFrom(address:'mailtrapclub@gmail.com', name:"John Doe"); //Sender's email and name
$mail->addAddress($email); // Recipient's email
//Content
$mail->isHTML(isHTML:false); //Set to true if sending HTML email
$mail->Subject = 'Email Verification';
$mail->Body = "Your verification code is: $verificationCode";
$mail->send();
return true;
}catch (Exception $e) {
return false;
}
}
//Example usage
$email = "mailtrapclub+test@gmail.com"
$verificationCode = generateVerificationCode();
if (sendVerificationEmail($email,$verificationCode)){
echo "A verification email has been sent to $email. Please check your inbox and enter the code to verrify your email." . PHP_EOL;
} else {
echo "Failed to send the verification email. Please try again later." . PHP_EOL;
}
Verifying verification token
Yeah, the title is a bit circular, but that’s exactly what you need. The script below enables the “verification of verification” flow 😀 that moves like this:
- A user hits the verification link.
- The token gets validated.
- The user’s email is marked as verified in the database.
<?php
$servername = "localhost";
$username = "root";
$password = "";
$dbname = "user_verification";
// Create connection
$conn = new mysqli($servername, $username, $password, $dbname);
// Check connection
if ($conn->connect_error) {
die("Connection failed: " . $conn->connect_error);
}
if (isset($_GET['token'])) {
$token = $_GET['token'];
$stmt = $conn->prepare("SELECT * FROM users WHERE token=? LIMIT 1"); $stmt->bind_param("s", $token); $stmt->execute();
$result = $stmt->get_result();
if ($result->num_rows > 0) {
$user = $result->fetch_assoc(); $stmt->close();
$stmt = $conn->prepare("UPDATE users SET is_verified=1, token=NULL WHERE id=?"); $stmt->bind_param("i", $user['id']);
if ($stmt->execute() === TRUE) {
echo "Email verification successful!";
} else {
echo "Error: " . $conn->error;
} $stmt->close();
} else {
echo "Invalid token!";
}
}
$conn->close();
?>
We appreciate you chose this article to know more about php email verification. To continue reading the article and discover more articles on related topics, follow Mailrap Blog!
This content originally appeared on DEV Community and was authored by Denys
Denys | Sciencx (2024-08-09T14:44:47+00:00) How to Set up Email Verification in PHP via a Verification Token: Complete Guide. Retrieved from https://www.scien.cx/2024/08/09/how-to-set-up-email-verification-in-php-via-a-verification-token-complete-guide/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.