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
b4a4050399
transparent-email/README.md
bkrukowski beb514e0b3 Magic in constructor is replaced by factory
2016-10-14 20:19:38 +02:00

2.0 KiB
Raw Blame History

Build Status Coverage Status Codacy Badge

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

Usage

use bkrukowski\TransparentEmail\TransparentEmailFactory;
use bkrukowski\TransparentEmail\Emails\Email;
use bkrukowski\TransparentEmail\Emails\InvalidEmailException;

try {
    $cleaner = TransparentEmailFactory::createDefault();
    $transformedEmail = $cleaner->getPrimaryEmail(new Email('John.Doe+alias@gmail.com'));
} catch (InvalidEmailException $exception) {
    // do something
}

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*:

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.