dillchuk/email-blur

A library to e-mail blur

Maintainers

Details

github.com/dillchuk/email-blur

Source

Installs: 528

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 1

2.0.0 2023-02-07 19:20 UTC

Requires

  • php: >=8.0

Requires (Dev)

MIT 875d21c36d68b408e1712a81fd16e2ff095d948b

  • Fernando WObeto <fernandowobeto.woop@gmail.com>
  • Derek Illchuk <derek.woop@illchuk.com>

This package is auto-updated.

Last update: 2024-05-07 22:35:33 UTC

README

This is version 2, derived from wobeto/email-blur.

To install via composer, run:

# composer require dillchuk/email-blur
# composer install

Use with default mask:

<?php

include 'vendor/autoload.php';
use Wobeto\EmailBlur\Blur;

$blur = new Blur();
$obscured = $blur->make('example@test.com');
var_dump($obscured); // exa***@t***.com

Use with mask changed:

$blur = new Blur(mask: '<REDACTED>');
$obscured = $blur->make('example@test.com');

var_dump($obscured); // exa<REDACTED>@t<REDACTED>.com

Handles free email providers:

$blur = new Blur();
$obscured = $blur->make('example@gmail.com');
var_dump($obscured); // exa***@gmail.com

$blur = new Blur(maskFree: true);
$obscured = $blur->make('example@gmail.com');
var_dump($obscured); // exa***@gm***.com

Handles second-level domains:

$blur = new Blur();
$obscured = $blur->make('example@example.co.uk');
var_dump($obscured); // exa***@exa***.co.uk

See additional configuration options in the constructor.

  • mask
  • maskDomain
  • maskFree