mirror of
https://github.com/retailcrm/transparent-email.git
synced 2024-11-22 13:26:06 +03:00
60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
[](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)
|
|
|
|
# Transparent Email
|
|
|
|
Transparent Email clears aliases from email address. Email `John.Doe+alias@gmail.com` will be transformed to `johndoe@gmail.com`.
|
|
|
|
## Why?
|
|
|
|
To detect multi-accounts on your website.
|
|
|
|
## Supported mailboxes
|
|
|
|
* [gmail.com](https://gmail.com) and [Google Apps](https://apps.google.com) with custom domain
|
|
* [tlen.pl](http://tlen.pl)
|
|
* [33mail.com](https://www.33mail.com)
|
|
* [outlook.com](http://outlook.com)
|
|
* [yahoo.com](http://mail.yahoo.com)
|
|
* [yandex.ru](https://yandex.ru/)
|
|
* [mail.ru](https://mail.ru/)
|
|
|
|
## Usage
|
|
|
|
```php
|
|
use bkrukowski\TransparentEmail\TransparentEmailFactory;
|
|
use bkrukowski\TransparentEmail\Emails\Email;
|
|
use bkrukowski\TransparentEmail\Emails\EmailInterface;
|
|
use bkrukowski\TransparentEmail\Emails\InvalidEmailException;
|
|
|
|
try {
|
|
$factory = new TransparentEmailFactory();
|
|
$cleaner = $factory->createDefault();
|
|
$inputEmail = new Email('John.Doe+alias@gmail.com');
|
|
/** @var EmailInterface $transformedEmail */
|
|
$transformedEmail = $cleaner->getPrimaryEmail($inputEmail);
|
|
echo $transformedEmail;
|
|
} catch (InvalidEmailException $exception) {
|
|
echo 'Invalid email!';
|
|
}
|
|
```
|
|
|
|
## Versioning
|
|
|
|
The version numbers follow the [Semantic Versioning 2.0.0](http://semver.org/) scheme.
|
|
|
|
## Yahoo.com
|
|
|
|
Aliases work different on Yahoo than on Gmail. On Gmail part after plus is skipped.
|
|
For example message sent to `janedoe+alias@gmail.com` will be redirected to `janedoe@gmail.com`.
|
|
|
|
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.
|
|
|
|
Therefore we do not know what is the real email, so in this case result will be `baseName@yahoo.com`,
|
|
which actually does not exist. |