Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 2.94 KB

README.md

File metadata and controls

74 lines (54 loc) · 2.94 KB

Build Status Coverage Status Codacy Badge

Transparent Email

Transparent Email clears aliases from email address. Email [email protected] will be transformed to [email protected].

Why?

To detect multi-accounts on your website.

Supported mailboxes

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('[email protected]');
    /** @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 [email protected] will be redirected to [email protected].

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 [email protected], which actually does not exist.

Yandex.ru

In official documentation you can find some use-cases about aliases usage.

Mail.ru

Mail.ru service uses following aliases:

Icloud.com

Icloud.com service uses following aliases: