danjam/gmail-matcher

Library to check and match the varying formats of Gmail addresses

1.0.0 2019-02-08 16:14 UTC

Requires

• php: ^7.1

Requires (Dev)

• ext-ast: *
• neronmoon/scriptsdev: ^0.1.4
• php-coveralls/php-coveralls: ^2.1
• phpmd/phpmd: ^2.6
• phpstan/phpstan: ^0.11.0
• phpstan/phpstan-phpunit: ^0.11.0
• phpstan/phpstan-strict-rules: ^0.11.0
• phpunit/phpunit: ^7
• povils/phpmnd: ^2.0
• sebastian/phpcpd: ^4.1
• sensiolabs/security-checker: ^5.0
• squizlabs/php_codesniffer: ^3.4

MIT

• Danny James

• gmail

README

TL;DR: This is a PHP 7.1+ class that can normalize and compare different formats of the same Gmail address.

Gmail address rules have some caveats:

• Dots in email addresses are disregarded ([e-mail] is the same as [e-mail]). (Source)
• Addresses are case insensitive ([e-mail] is the same as [e-mail])
• The gmail.com domain is interchangeable with googlemail.com ([e-mail] is the same as [e-mail]) (Source)
• Pluses are allowed in emails ([e-mail])

Because of this it is very possible for a system to have multiple variations of the same Gmail address associated with different users.

This class attempts to address this by providing a match(…) method to check variations against each other and a normalize(…) method to retrieve a normalized version of the address. Also exposed is a method for determining if an address is a Gamil address, isGmailAddress(…).

Between these three methods it should be possible to check, normalize and store Gmail addresses, for example to prevent duplicate signups within a system.

Install

Via Composer

$ composer require danjam/gmail-matcher

Usage

// instantiate new matcher
$gmailMatcher = new \danjam\GmailMatcher\GmailMatcher();

// you can also specify the domain used when normalizing. Must be one of gmail.com, googlemail.com. Defaults to gmail.com
$gmailMatcher = new \danjam\GmailMatcher\GmailMatcher('googlemail.com');

// normalizes the address - returns [e-mail]
$gmailMatcher->normalize('[e-mail]');

// check if two addresses are the same - returns true
$gmailMatcher->match('[e-mail]', '[e-mail]');

// returns false
$gmailMatcher->match('[e-mail]', '[e-mail]');

// returns false - addresses with + should NOT be treated as the same address
$mailMatcher->match('foo@gmail', '[e-mail]');

// multiple addresses
$gmailMatcher->match('[e-mail]', '[e-mail]', '[e-mail]', ...);

// validate the address is a Gmail address - returns true
$gmailMatcher->isGmailAddress('[e-mail]');

// returns false
$gmailMatcher->isGmailAddress('[e-mail]');