|
1 | 1 | # php-mailgun-validation
|
2 |
| -Validate email address with Mailgun's validation service (Syntax checks, DNS validation, MX validation) |
| 2 | +Validate email address with Mailgun's validation service (Syntax checks, DNS validation, MX validation) |
| 3 | +You can view Mailgun's blog post about the service here: http://blog.mailgun.com/free-email-validation-api-for-web-forms/ |
| 4 | +An API key is required to use this library, it can be obtained for free from mailgun's site after signup: |
| 5 | +https://mailgun.com/app/account/security |
| 6 | + |
| 7 | +The service is free, however fair usage limits do apply (detailed in the post linked above). |
| 8 | + |
| 9 | +You can install this package using composer: |
| 10 | + |
| 11 | + composer require overint/php-mailgun-validation |
| 12 | + |
| 13 | +Example Use Case |
| 14 | +--------- |
| 15 | + |
| 16 | + <?php |
| 17 | + require 'vendor\autoload.php'; |
| 18 | + use overint\MailgunValidator; |
| 19 | + |
| 20 | + $validator = new MailgunValidator('your-mailgun-public-key'); |
| 21 | + |
| 22 | + echo var_dump($validator->validate('test@example.com')); //bool(false) |
| 23 | + echo var_dump($validator->validate('someuser@gmail.com')); //bool(true) |
| 24 | + echo var_dump($validator->validate('someuser@hotmail.com')); //bool(true) |
| 25 | + echo var_dump($validator->validate('someuser@aol.com')); //bool(true) |
| 26 | + echo var_dump($validator->validate('misformed@domain')); //bool(false) |
| 27 | + echo var_dump($validator->validate('invalid@anonexistingdomain.com')); //bool(false) |
| 28 | + |
| 29 | + echo var_dump($validator->validateExtended('someuser@ymail.com')); |
| 30 | + |
| 31 | + // object(stdClass)#2 (4) { |
| 32 | + // ["address"]=> |
| 33 | + // string(19) "someuser@ymail.com" |
| 34 | + // ["did_you_mean"]=> |
| 35 | + // NULL |
| 36 | + // ["is_valid"]=> |
| 37 | + // bool(true) |
| 38 | + // ["parts"]=> |
| 39 | + // object(stdClass)#4 (3) { |
| 40 | + // ["display_name"]=> |
| 41 | + // NULL |
| 42 | + // ["domain"]=> |
| 43 | + // string(10) "mailme.com" |
| 44 | + // ["local_part"]=> |
| 45 | + // string(8) "someuser" |
| 46 | + // } |
| 47 | + // } |
0 commit comments