bkrukowski/transparent-email

Remove aliases from email and get primary email account

v0.5.0 2016-10-26 18:22 UTC

Requires

• php: ^7.0.0

Requires (Dev)

• codacy/coverage: ^1.0.3
• phpunit/phpunit: ^5.5.4
• satooshi/php-coveralls: ^1.0.1

MIT

• Bartłomiej Krukowski

README

Transparent Email

Transparent Email clears aliases from email address. Email [e-mail] will be transformed to [e-mail].

Why?

To detect multi-accounts on your website.

Supported mailboxes

• gmail.com and Google Apps with custom domain
• tlen.pl
• 33mail.com
• outlook.com
• yahoo.com

Usage

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('[e-mail]');
    /** @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 scheme.

Yahoo.com

Aliases work different on Yahoo than on Gmail. On Gmail part after plus is skipped. For example message sent to [e-mail] will be redirected to [e-mail].

Yahoo uses the following pattern*:

[e-mail]

• 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 [e-mail], which actually does not exist.