README

English | Русский

EMAIL CSE HELPERS

The helpers allows you manipulating, extract, detecting EMAIL.

Project repository: https://github.com/cs-eliseev/helpers-email

DEMO

switch (true) {
    case Email::is($emial):
        break;
    case Email::exist($emial):
        $emial = Email::extract($emial);
        break;
    default:
        new Exception('Email is not exist');
}

$emial = Email::hide($emial);

Introduction

CSE HELPERS is a collection of several libraries with simple functions written in PHP for people.

Despite using PHP as the main programming language for the Internet, its functions are not enough. EMAIL CSE HELPERS for manipulating, extract and detecting email.

CSE HELPERS was created for the rapid development of web applications.

CSE Helpers project:

• Array CSE helpers
• Cookie CSE helpers
• Date CSE helpers
• Email CSE helpers
• IP CSE helpers
• Json CSE helpers
• Math Converter CSE helpers
• Phone CSE helpers
• Request CSE helpers
• Session CSE helpers
• Word CSE helpers

Below you will find some information on how to init library and perform common commands.

Install

You can find the most recent version of this project here.

Composer

Execute the following command to get the latest version of the package:

composer require cse/helpers-email

Or file composer.json should include the following contents:

{
    "require": {
        "cse/helpers-email": "*"
    }
}

Git

Clone this repository locally:

git clone https://github.com/cs-eliseev/helpers-email.git

Download

Download the latest release here.

Usage

The class consists of static methods that are conveniently used in any project. See example examples-email.php.

HIDE email

Example short email:

Email::hide('mail@google.com');
// m***@google.com

Example medium email:

Email::hide('email@google.com');
// m***l@google.com

Example large email:

Email::hide('email2018@google.com');
// e***l***8@google.com

CHECK DOMAIN to email

Example:

$domain = 'google.com';
Email::checkDomain('mail@google.com', $domain);
// true
Email::checkDomain('mail@mail.ru', $domain);
// false

IS email

Example:

Email::is('mail@google.com');
// true

Check email to string:

Email::is('Example text mail@google.com');
// false

EXIST email

Example:

Email::exist('mail@google.com');
// true

Check email to string:

Email::exist('Example text mail@google.com');
// true

Change pattern:

Email::exist('Example text mail@inbox.com', '([a-z]+@google.com)');
// false

EXTRACT email from string

Example:

Email::extract('Example text mail@google.com');
// mail@google.com

Change pattern:

Email::extract('Example text mail@inbox.com', '([a-z]+@google.com)');
// null

EXTRACT ALL email from string

Example:

Email::extract('Example text mail@google.com, mail@inbox.com');
/**
* [
*     0 => 'mail@google.com',
*     1 => 'mail@inbox.com'
* ]
*/

Change pattern:

Email::extract('Example text mail@google.com, mail@inbox.com', '([a-z]+@google.com)');
/**
* [
*     0 => 'mail@google.com'
* ]
*/

Testing & Code Coverage

PHPUnit is used for unit testing. Unit tests ensure that class and methods does exactly what it is meant to do.

General PHPUnit documentation can be found at https://phpunit.de/documentation.html.

To run the PHPUnit unit tests, execute:

phpunit PATH/TO/PROJECT/tests/

If you want code coverage reports, use the following:

phpunit --coverage-html ./report PATH/TO/PROJECT/tests/

Used PHPUnit default config:

phpunit --configuration PATH/TO/PROJECT/phpunit.xml

Donating

You can support this project here. You can also help out by contributing to the project, or reporting bugs. Even voicing your suggestions for features is great. Anything to help is much appreciated.

License

The EMAIL CSE HELPERS is open-source PHP library licensed under the MIT license. Please see License File for more information.

GitHub @cs-eliseev