RetailCRM-Mirror/transparent-email
1
0
Fork 0
mirror of https://github.com/retailcrm/transparent-email.git synced 2024-12-01 09:46:03 +03:00
Code Issues Projects Releases Wiki Activity

Short documentation

Browse Source
This commit is contained in:
bkrukowski 2016-09-10 02:10:17 +02:00
parent cda8b9b99f
commit 4dea33c732
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,3 +1,20 @@
[![Build Status](https://travis-ci.org/bkrukowski/gordianus.svg?branch=master)](https://travis-ci.org/bkrukowski/gordianus) [![Build Status](https://travis-ci.org/bkrukowski/gordianus.svg?branch=master)](https://travis-ci.org/bkrukowski/gordianus)
[![Coverage Status](https://coveralls.io/repos/github/bkrukowski/gordianus/badge.svg?branch=master)](https://coveralls.io/github/bkrukowski/gordianus?branch=master) [![Coverage Status](https://coveralls.io/repos/github/bkrukowski/gordianus/badge.svg?branch=master)](https://coveralls.io/github/bkrukowski/gordianus?branch=master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b057fa037a3b4f318f75af27b0b01d47)](https://www.codacy.com/app/bartlomiej-krukowski/gordianus?utm_source=github.com&utm_medium=referral&utm_content=bkrukowski/gordianus&utm_campaign=Badge_Grade) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b057fa037a3b4f318f75af27b0b01d47)](https://www.codacy.com/app/bartlomiej-krukowski/gordianus?utm_source=github.com&utm_medium=referral&utm_content=bkrukowski/gordianus&utm_campaign=Badge_Grade)
# Gordianus
Gordianus clears aliases from email address. Email John.Doe+alias@gmail.com will be transformed to johndoe@gmail.com.
## Supported mailboxes
* [gmail](https://gmail.com)
* [tlen.pl](http://tlen.pl)
* [33mail.com](https://www.33mail.com)
## Usage
```php
$gordianus = new \bkrukowski\Gordianus\Gordianus();
$transformedEmail = $gordianus->getPrimaryEmail('John.Doe+alias@gmail.com');
```