Documentation

This commit is contained in:
bkrukowski 2016-09-24 12:54:02 +02:00
parent 4614dcd7aa
commit 7d3895cfd4

View File

@ -21,11 +21,16 @@ To detect multi-accounts on your website.
## Usage ## Usage
```php ```php
use \bkrukowski\TransparentEmail\TransparentEmail; use bkrukowski\TransparentEmail\TransparentEmail;
use \bkrukowski\TransparentEmail\Emails\Email; use bkrukowski\TransparentEmail\Emails\Email;
use bkrukowski\TransparentEmail\Emails\InvalidEmailException;
try {
$cleaner = new TransparentEmail(); $cleaner = new TransparentEmail();
$transformedEmail = $cleaner->getPrimaryEmail(new Email('John.Doe+alias@gmail.com')); $transformedEmail = $cleaner->getPrimaryEmail(new Email('John.Doe+alias@gmail.com'));
} catch (InvalidEmailException $exception) {
// do something
}
``` ```
## Yahoo.com ## Yahoo.com