From 66e1c8e603a3597c3ca5a11eb9544d12fd97236a Mon Sep 17 00:00:00 2001 From: bkrukowski Date: Sat, 10 Sep 2016 14:10:52 +0200 Subject: [PATCH] Documentation --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64562ed..cf30f0b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ 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 * [gmail.com](https://gmail.com) @@ -19,4 +23,20 @@ Gordianus clears aliases from email address. Email `John.Doe+alias@gmail.com` wi ```php $gordianus = new \bkrukowski\Gordianus\Gordianus(); $transformedEmail = $gordianus->getPrimaryEmail('John.Doe+alias@gmail.com'); -``` \ No newline at end of file +``` + +## 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. \ No newline at end of file