RetailCRM-Mirror/transparent-email
1
0
Fork 0
mirror of https://github.com/retailcrm/transparent-email.git synced 2024-11-22 05:16:05 +03:00
Code Issues Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
bkrukowski 2016-09-10 14:10:52 +02:00
parent 1aa23920fd
commit 66e1c8e603
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -6,6 +6,10 @@
Gordianus clears aliases from email address. Email `John.Doe+alias@gmail.com` will be transformed to `johndoe@gmail.com`. Gordianus clears aliases from email address. Email `John.Doe+alias@gmail.com` will be transformed to `johndoe@gmail.com`.
## Why?
To detect multi-accounts in your website.
## Supported mailboxes ## Supported mailboxes
* [gmail.com](https://gmail.com) * [gmail.com](https://gmail.com)
@ -19,4 +23,20 @@ Gordianus clears aliases from email address. Email `John.Doe+alias@gmail.com` wi
```php ```php
$gordianus = new \bkrukowski\Gordianus\Gordianus(); $gordianus = new \bkrukowski\Gordianus\Gordianus();
$transformedEmail = $gordianus->getPrimaryEmail('John.Doe+alias@gmail.com'); $transformedEmail = $gordianus->getPrimaryEmail('John.Doe+alias@gmail.com');
``` ```
## Yahoo.com
Aliases work different on Yahoo than on Gmail. On Gmail part after plus is skipped.
For example message sent to `jane.doe+alias@gmail.com` will be redirected to `jane.doe@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*-alias@yahoo.com.