Conceal e-mail addresses in a string
Conceal e-mail addresses in a string by replacing their domain. Useful for concealing up production data—like MySQL dumps—so you can use it locally without worrying about having real addresses on your system.
use Spatie\EmailConcealer\Concealer;
$concealer = Concealer::create();
$concealer->conceal('info@spatie.be');
// "info@example.com"
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Installation
You can install the package via composer:
composer require spatie/email-concealer
Usage
To conceal a string, create an Concealer instance. and call the conceal method.
use Spatie\EmailConcealer\Concealer;
$concealer = Concealer::create();
$concealer->conceal('info@spatie.be');
// "info@example.com"
The concealer processes every e-mail address it finds in the string. It will ensure that there aren't any unwanted duplicates if the local-part is the same.
$concealer->conceal('info@spatie.be,info@foo.com,info@bar.com');
// "info@example.com,info-1@foo.com,info-2@bar.com"
Equal e-mail addresses will always conceal to the same concealed address.
$concealer->conceal('info@spatie.be,info@foo.com,info@spatie.be');
// "info@example.com,info-1@example.com,info@example.com"
If you want to use a different domain than example.com, use the domain method to set a new one.
$concealer = Concealer::create()->domain('foo.com');
echo $concealer->conceal('info@spatie.be'); // "info@foo.com"
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
Credits
About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.
