Skip to content

Latest commit

 

History

History
145 lines (98 loc) · 3.86 KB

README.md

File metadata and controls

145 lines (98 loc) · 3.86 KB
Raw

VerifyEmail

Is a PHP class that can be easily used to verify an email address and make sure it is valid and does exist on the mail server.

This class connects to the mail server and checks whether the mailbox exists or not.

Blog posts:

Description: http://curlybrac.es/2016/07/25/verifyemail-php-class-to-validate-email-address/

How to configure mail server: http://curlybrac.es/2016/07/27/how-to-configure-a-mail-server/

How to install (using composer):

Add the package to composer.json

{
	"require": {
		"hbattat/verifyemail": "<version number>"
	}
}

Then add the autoload to your file:

require 'vendor/autoload.php';

That's all, now you are ready to use that class!

How to use:

Initialize the class:

$ve = new hbattat\VerifyEmail('[email protected]', '[email protected]');

OR (you can specify other port number than 25)

$ve = new hbattat\VerifyEmail('[email protected]', '[email protected]', 26);

The first email address '[email protected]' is the one to be checked, and the second '[email protected]' is an email address to be provided to the server. This email needs to be valid and from the same server that the script is running from. To make sure your server is not treated as a spam or gets blacklisted check the score of your server here https://mail-tester.com

Then you call the verify function:

var_dump($ve->verify());

This will return a boolean. True if the email is valid, false otherwise.

bool(true)

If you want to get any errors, call this function after the verify function:

print_r($ve->get_errors());

This will return an array of all errors (if any):

Array
(
    [0] => No suitable MX records found.
)

If you want to get all debug messages of the connection, call this function:

print_r($ve->get_debug());

This will return an array of all messages and values that used during the process.

Array
(
    [0] => initialized with Email: h*****@gmail.com, Verifier Email: [email protected], Port: 25
    [1] => Verify function was called.
    [2] => Finding MX record...
    [3] => Found MX: alt4.gmail-smtp-in.l.google.com
    [4] => Connecting to the server...
    [5] => Connection to server was successful.
    [6] => Starting veriffication...
    [7] => Got a 220 response. Sending HELO...
    [8] => Response: 250 mx.google.com at your service

    [9] => Sending MAIL FROM...
    [10] => Response: 250 2.1.0 OK gw8si3985770wjb.84 - gsmtp

    [11] => Sending RCPT TO...
    [12] => Response: 250 2.1.5 OK gw8si3985770wjb.84 - gsmtp

    [13] => Sending QUIT...
    [14] => Looking for 250 response...
    [15] => Found! Email is valid.
)

And to see the raw debug messages of the server commands sent

print_r($ve->get_debug(true));

which will return an array:

Array
(
    [helo] => 250 mx.google.com at your service
    [mail_from] => 250 2.1.0 OK a68si4170774ioe.18 - gsmtp
    [rcpt_to] => 250 2.1.5 OK a68si4170774ioe.18 - gsmtp
    [quit] => 4
)

Other Examples:

You can also modify/set the values of email to verify, verifier email, and port number on the fly after initializing

$ve->set_email('<another email Address to verify>');
$ve->set_verifier_email('<another verifier email>');
$ve->set_port(<port number>);

Notes:

  • Some mail servers will silently reject the test message, to prevent spammers from checking against their users' emails and filter the valid emails, so this function might not work properly with all mail servers.

  • You server must be configured properly as a mail server to avoid being blocked or blacklisted. This includes things like SSL, SPF records, Domain Keys, DMARC records, etc. To check your server use this tool https://mail-tester.com