Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cs-eliseev/helpers-email
The helpers allows you manipulating, extract, detecting email.
https://github.com/cs-eliseev/helpers-email
collection collections cse email emails framework helper helpers library mail mails php tool tools utilities utility utils
Last synced: about 2 months ago
JSON representation
The helpers allows you manipulating, extract, detecting email.
- Host: GitHub
- URL: https://github.com/cs-eliseev/helpers-email
- Owner: cs-eliseev
- License: mit
- Created: 2019-02-22T07:09:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-06T04:57:19.000Z (over 5 years ago)
- Last Synced: 2024-08-08T20:53:57.838Z (6 months ago)
- Topics: collection, collections, cse, email, emails, framework, helper, helpers, library, mail, mails, php, tool, tools, utilities, utility, utils
- Language: PHP
- Homepage:
- Size: 46.9 KB
- Stars: 6
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
English | [Русский](https://github.com/cs-eliseev/helpers-email/blob/master/README.ru_RU.md)
EMAIL CSE HELPERS
=======
[](https://travis-ci.org/cs-eliseev/helpers-email)
[](https://codecov.io/gh/cs-eliseev/helpers-email)
[](https://scrutinizer-ci.com/g/cs-eliseev/helpers-email/?branch=master)
[](https://packagist.org/packages/cse/helpers-email)
[](https://packagist.org/packages/cse/helpers-email)
[](https://github.com/cs-eliseev/helpers-email/blob/master/LICENSE.md)
[](https://github.com/cs-eliseev/helpers-email/archive/master.zip)
The helpers allows you manipulating, extract, detecting EMAIL.
Project repository: https://github.com/cs-eliseev/helpers-email
**DEMO**
```php
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](https://github.com/cs-eliseev/helpers/blob/master/README.md) 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](https://github.com/cs-eliseev/helpers/blob/master/README.md) was created for the rapid development of web applications.
**CSE Helpers project:**
* [Array CSE helpers](https://github.com/cs-eliseev/helpers-arrays)
* [Cookie CSE helpers](https://github.com/cs-eliseev/helpers-cookie)
* [Date CSE helpers](https://github.com/cs-eliseev/helpers-date)
* [Email CSE helpers](https://github.com/cs-eliseev/helpers-email)
* [IP CSE helpers](https://github.com/cs-eliseev/helpers-ip)
* [Json CSE helpers](https://github.com/cs-eliseev/helpers-json)
* [Math Converter CSE helpers](https://github.com/cs-eliseev/helpers-math-converter)
* [Phone CSE helpers](https://github.com/cs-eliseev/helpers-phone)
* [Request CSE helpers](https://github.com/cs-eliseev/helpers-request)
* [Session CSE helpers](https://github.com/cs-eliseev/helpers-session)
* [Word CSE helpers](https://github.com/cs-eliseev/helpers-word)
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](https://github.com/cs-eliseev/helpers-email).
### Composer
Execute the following command to get the latest version of the package:
```bash
composer require cse/helpers-email
```
Or file composer.json should include the following contents:
```json
{
"require": {
"cse/helpers-email": "*"
}
}
```
### Git
Clone this repository locally:
```bash
git clone https://github.com/cs-eliseev/helpers-email.git
```
### Download
[Download the latest release here](https://github.com/cs-eliseev/helpers-email/archive/master.zip).
## Usage
The class consists of static methods that are conveniently used in any project.
See example [examples-email.php](https://github.com/cs-eliseev/helpers-email/blob/master/examples/examples-email.php).
**HIDE email**
Example short email:
```php
Email::hide('[email protected]');
// m***@google.com
```
Example medium email:
```php
Email::hide('[email protected]');
// m***[email protected]
```
Example large email:
```php
Email::hide('[email protected]');
// e***l***[email protected]
```
**CHECK DOMAIN to email**
Example:
```php
$domain = 'google.com';
Email::checkDomain('[email protected]', $domain);
// true
Email::checkDomain('[email protected]', $domain);
// false
```
**IS email**
Example:
```php
Email::is('[email protected]');
// true
```
Check email to string:
```php
Email::is('Example text [email protected]');
// false
```
**EXIST email**
Example:
```php
Email::exist('[email protected]');
// true
```
Check email to string:
```php
Email::exist('Example text [email protected]');
// true
```
Change pattern:
```php
Email::exist('Example text [email protected]', '([a-z][email protected])');
// false
```
**EXTRACT email from string**
Example:
```php
Email::extract('Example text [email protected]');
// [email protected]
```
Change pattern:
```php
Email::extract('Example text [email protected]', '([a-z][email protected])');
// null
```
**EXTRACT ALL email from string**
Example:
```php
Email::extract('Example text [email protected], [email protected]');
/**
* [
* 0 => '[email protected]',
* 1 => '[email protected]'
* ]
*/
```
Change pattern:
```php
Email::extract('Example text [email protected], [email protected]', '([a-z][email protected])');
/**
* [
* 0 => '[email protected]'
* ]
*/
```
## 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:
```bash
phpunit PATH/TO/PROJECT/tests/
```
If you want code coverage reports, use the following:
```bash
phpunit --coverage-html ./report PATH/TO/PROJECT/tests/
```
Used PHPUnit default config:
```bash
phpunit --configuration PATH/TO/PROJECT/phpunit.xml
```
## Donating
You can support this project [here](https://www.paypal.me/cseliseev/10usd).
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](https://github.com/cs-eliseev/helpers-email/blob/master/LICENSE.md) for more information.
***
> GitHub [@cs-eliseev](https://github.com/cs-eliseev)