2016-09-10 16:29:03 +03:00
[](https://travis-ci.org/bkrukowski/transparent-email)
[](https://coveralls.io/github/bkrukowski/transparent-email?branch=master)
[](https://www.codacy.com/app/bartlomiej-krukowski/transparent-email?utm_source=github.com& utm_medium=referral& utm_content=bkrukowski/transparent-email& utm_campaign=Badge_Grade)
2016-09-10 03:10:17 +03:00
2016-09-10 16:13:55 +03:00
# Transparent Email
2016-09-10 03:10:17 +03:00
2016-09-10 16:13:55 +03:00
Transparent Email clears aliases from email address. Email `John.Doe+alias@gmail.com` will be transformed to `johndoe@gmail.com` .
2016-09-10 03:10:17 +03:00
2016-09-10 15:10:52 +03:00
## Why?
2016-09-10 15:11:19 +03:00
To detect multi-accounts on your website.
2016-09-10 15:10:52 +03:00
2016-09-10 03:10:17 +03:00
## Supported mailboxes
2016-09-16 02:20:39 +03:00
* [gmail.com ](https://gmail.com ) and [Google Apps ](https://apps.google.com ) with custom domain
2016-09-10 03:10:17 +03:00
* [tlen.pl ](http://tlen.pl )
* [33mail.com ](https://www.33mail.com )
2016-09-10 13:15:37 +03:00
* [outlook.com ](http://outlook.com )
2016-09-10 14:33:57 +03:00
* [yahoo.com ](http://mail.yahoo.com )
2020-02-18 16:56:53 +03:00
* [icloud.com ](https://www.icloud.com/ )
2020-02-13 13:00:21 +03:00
* [yandex.ru ](https://yandex.ru/ )
* [mail.ru ](https://mail.ru/ )
2016-09-10 03:10:17 +03:00
## Usage
```php
2016-10-14 21:19:38 +03:00
use bkrukowski\TransparentEmail\TransparentEmailFactory;
2016-09-24 13:54:02 +03:00
use bkrukowski\TransparentEmail\Emails\Email;
2016-10-14 22:15:15 +03:00
use bkrukowski\TransparentEmail\Emails\EmailInterface;
2016-09-24 13:54:02 +03:00
use bkrukowski\TransparentEmail\Emails\InvalidEmailException;
try {
2016-10-26 21:13:11 +03:00
$factory = new TransparentEmailFactory();
$cleaner = $factory->createDefault();
2016-10-14 22:15:15 +03:00
$inputEmail = new Email('John.Doe+alias@gmail.com');
/** @var EmailInterface $transformedEmail */
$transformedEmail = $cleaner->getPrimaryEmail($inputEmail);
echo $transformedEmail;
2016-09-24 13:54:02 +03:00
} catch (InvalidEmailException $exception) {
2016-10-14 22:15:15 +03:00
echo 'Invalid email!';
2016-09-24 13:54:02 +03:00
}
2016-09-10 15:10:52 +03:00
```
2016-10-14 21:38:37 +03:00
## Versioning
The version numbers follow the [Semantic Versioning 2.0.0 ](http://semver.org/ ) scheme.
2016-09-10 15:10:52 +03:00
## Yahoo.com
Aliases work different on Yahoo than on Gmail. On Gmail part after plus is skipped.
2016-09-13 19:20:51 +03:00
For example message sent to `janedoe+alias@gmail.com` will be redirected to `janedoe@gmail.com` .
2016-09-10 15:10:52 +03:00
Yahoo uses the following pattern[*](https://help.yahoo.com/kb/SLN16026.html):
*baseName*-*keyword*@yahoo.com
* *baseName* - value defined by the user, different than email login;
* *keyword* - one from a list of keywords defined by the user.
2016-09-10 15:45:30 +03:00
Therefore we do not know what is the real email, so in this case result will be `baseName@yahoo.com` ,
2020-02-17 12:00:02 +03:00
which actually does not exist.
## Yandex.ru
In official [documentation ](https://yandex.com/support/mail/web/preferences/about-sender/additional-addresses.html ) you can find some use-cases about aliases usage.
## Mail.ru
2020-02-18 16:56:53 +03:00
Mail.ru service uses following aliases:
2020-02-17 12:00:02 +03:00
* `janedoe+alias@mail.ru` will be redirected to `janedoe@mail.ru`
2020-02-17 17:00:23 +03:00
* `janeDoe@MAIL.RU` will be redirected to `janedoe@mail.ru`
2020-02-18 16:56:53 +03:00
## Icloud.com
Icloud.com service uses following aliases:
* `janedoe+alias@icloud.com` will be redirected to `janedoe@icloud.com`
* `janeDoe@ICLOUD.COM` will be redirected to `janedoe@icloud.com`
