1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
# SMTP\_Validate\_Email
[](https://packagist.org/packages/zytzagoo/smtp-validate-email)
[](LICENSE.txt)
[](https://travis-ci.org/zytzagoo/smtp-validate-email)
[](https://scrutinizer-ci.com/g/zytzagoo/smtp-validate-email/?branch=master)
Perform email address validation/verification via SMTP.
The `SMTPValidateEmail\Validator` class retrieves MX records for the email domain and then connects to the
domain's SMTP server to try figuring out if the address really exists.
Earlier versions (before 1.0) used the `SMTP_Validate_Email` class name (and did not use namespaces and other now-common PHP features). Care has been taken to keep the old API and migrating old code should be painless. See ["Migrating to 1.0 from older versions"](#migrating-to-1.0-from-older-versions) section. Or just use/download the ancient [0.7 version](https://github.com/zytzagoo/smtp-validate-email/releases/tag/v0.7).
## Features
* Not actually sending the message, gracefully resetting the SMTP session when done
* Command-specific communication timeouts implemented per relevant RFCs
* Catch-all account detection
* Batch mode processing supported
* Logging/debugging support
* No external dependencies
* Covered with unit/functional tests
## Installation
Install via [composer](https://getcomposer.org/):
`composer require zytzagoo/smtp-validate-email --update-no-dev`
## Usage examples
### Basic example
```php
<?php
require 'vendor/autoload.php';
use SMTPValidateEmail\Validator as SmtpEmailValidator;
/**
* Simple example
*/
$email = 'someone@example.org';
$sender = 'sender@example.org';
$validator = new SmtpEmailValidator($email, $sender);
// If debug mode is turned on, logged data is printed as it happens:
// $validator->debug = true;
$results = $validator->validate();
var_dump($results);
// Get log data (log data is always collected)
$log = $validator->getLog();
var_dump($log);
```
### Multiple recipients and other details
```php
<?php
require 'vendor/autoload.php';
use SMTPValidateEmail\Validator as SmtpEmailValidator;
/**
* Validating multiple addresses/recipients at once:
* (checking multiple addresses belonging to the same server
* uses a single connection)
*/
$emails = [
'someone@example.org',
'someone.else@example.com'
];
$sender = 'sender@example.org';
$validator = new SmtpEmailValidator($email, $sender):
$results = $validator->validate();
var_dump($results);
/**
* The `validate()` method accepts the same parameters
* as the constructor, so this is equivalent to the above:
*/
$emails = [
'someone@example.org',
'someone.else@example.com'
];
$sender = 'sender@example.org';
$validator = new SmtpEmailValidator():
$results = $validator->validate($emails, $sender);
var_dump($results);
```
## Migrating to 1.0 from older versions
Earlier versions used the global `SMTP_Validate_Email` classname.
You can keep using that name in your existing code and still switch to the newer (composer-powered) version by using [aliasing/importing](http://php.net/manual/en/language.namespaces.importing.php) like this:
Require the composer package:
`composer require zytzagoo/smtp-validate-email --update-no-dev`
And then in your code:
```php
<?php
require 'vendor/autoload.php';
use SMTPValidateEmail\Validator as SMTP_Validate_Email;
// Now any old code referencing `SMTP_Validate_Email` should still work as it did earlier
```
## Development & Contributions
See the [Makefile](Makefile) and the development dependencies in [composer.json](composer.json) and [package.json](package.json).
Running `make` once you clone (or download) the repository gives you:
```
Usage: make [target]
[target] help
-------- ----
help What you're currently reading
install Installs dev dependencies
test Runs tests
coverage Runs tests with code coverage
$(PIDFILE) Starts the smtp-sink server
server-start Stops and starts the smtp-sink server
server-stop Stops smtp-sink server if it's running
clean Removes installed dev dependencies
```
So, run `make install` to get started. Afterwards you should be able to run the tests.
Tests are powered by `phpunit` and a local `smtp-sink` instance running on port 1025.
If `smtp-sink` is unavailable, tests requiring it are marked as skipped.
Pull requests are welcome!
In order to get your pull-request merged, please follow these simple rules:
* all code submissions must pass cleanly (no errors) with `make test`
* stick to existing code style (`phpcs` is used)
* there should be no external dependencies
* if you want to add significant features/dependencies, file an issue about it first so we can discuss whether the addition makes sense for the project
## [Changelog](CHANGELOG.md)
## [License (GPL-3.0+)](LICENSE.txt)
|
