PHPackages                             arraypress/email-utils - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Validation &amp; Sanitization](/categories/validation)
4. /
5. arraypress/email-utils

ActiveLibrary[Validation &amp; Sanitization](/categories/validation)

arraypress/email-utils
======================

An immutable value object for working with email addresses, providing parsing, validation, transformation, and analysis.

019PHP

Since Dec 15Pushed 5mo agoCompare

[ Source](https://github.com/arraypress/email-utils)[ Packagist](https://packagist.org/packages/arraypress/email-utils)[ RSS](/packages/arraypress-email-utils/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Email Utils
===========

[](#email-utils)

An immutable value object for working with email addresses. Provides parsing, validation, transformation, and analysis.

Installation
------------

[](#installation)

```
composer require arraypress/email-utils
```

Usage
-----

[](#usage)

### Basic Parsing

[](#basic-parsing)

```
use ArrayPress\EmailUtils\Email;

$email = Email::parse( 'david+newsletter@gmail.com' );

if ( $email ) {
    $email->domain();        // 'gmail.com'
    $email->local();         // 'david+newsletter'
    $email->tld();           // 'com'
    $email->base_address();  // 'david@gmail.com'
    $email->subaddress();    // 'newsletter'
}
```

### One-Liners

[](#one-liners)

```
$domain = Email::parse( $input )?->domain();
$score  = Email::parse( $input )?->spam_score() ?? 100;
$valid  = Email::parse( $input )?->valid() ?? false;
```

### Detection

[](#detection)

```
$email = Email::parse( 'admin@harvard.edu' );

$email->valid();                 // true
$email->is_educational();        // true
$email->is_role_based();         // true
$email->is_common_provider();    // false
$email->is_authority_provider(); // false
$email->is_government();         // false
$email->is_military();           // false
$email->is_private();            // false
$email->is_auto_generated();     // false
$email->has_mx();                // true (DNS lookup)
```

### Pattern Matching

[](#pattern-matching)

```
$email = Email::parse( 'user@company.edu' );

// Match against a list of patterns
$email->matches_any( [ '.edu', '@company.com' ] );  // true
$email->matches_any( [ '.gov', '@test.com' ] );     // false

// Match a single pattern
$email->matches_pattern( '.edu' );          // true
$email->matches_pattern( '@company.edu' );  // true
$email->matches_pattern( 'company.edu' );   // true (partial domain)

// Match all patterns
$email->matches_all( [ '.edu', 'company.edu' ] );  // true

// Pattern validation (static)
Email::is_valid_pattern( '@domain.com' );  // true
Email::is_valid_pattern( '.edu' );         // true
Email::is_valid_pattern( 'invalid' );      // false

// Get pattern type (static)
Email::get_pattern_type( 'user@test.com' );  // 'email'
Email::get_pattern_type( '@domain.com' );    // 'domain'
Email::get_pattern_type( '.edu' );           // 'tld'
Email::get_pattern_type( 'company.com' );    // 'partial'

// Filter valid patterns (static)
Email::filter_valid_patterns( [ '@test.com', '', '.edu', 'bad' ] );
// Returns: [ '@test.com', '.edu' ]
```

#### Supported Pattern Types

[](#supported-pattern-types)

PatternExampleMatchesFull email`user@test.com`Exact email match onlyDomain`@company.com`Any email ending with @company.comTLD`.edu`Any email ending with .eduPartial domain`company.com`@company.com and @sub.company.com### Typo Detection

[](#typo-detection)

```
$email = Email::parse( 'user@gmial.com' );

$email->has_typo();          // true
$email->suggested_domain();  // 'gmail.com'
$email->suggested_email();   // 'user@gmail.com'
```

### Transformations

[](#transformations)

```
$email = Email::parse( 'david@gmail.com' );

// Immutable - returns new instances
$email->with_subaddress( 'shopping' );  // david+shopping@gmail.com
$email->with_tag( 'newsletter' );       // david+newsletter-2025@gmail.com
$email->with_domain( 'yahoo.com' );     // david@yahoo.com
$email->with_local( 'john' );           // john@gmail.com
$email->without_subaddress();           // david@gmail.com
```

### Output Formats

[](#output-formats)

```
$email = Email::parse( 'david@gmail.com' );

$email->to_anonymized();      // 'da***@gm***.com'
$email->to_masked( 2, 1 );    // 'da**d@gmail.com'
$email->to_hashed();          // 'a1b2c3...@gmail.com'
$email->to_hashed( true );    // 'a1b2c3...@d4e5f6...'
$email->to_placeholder();     // 'deleted@site.invalid'
```

### Spam Scoring

[](#spam-scoring)

```
$email = Email::parse( 'xj382kd92@dodgy.xyz' );

$email->spam_score();        // 0-100 (higher = worse)
$email->spam_score( true );  // Include MX check
$email->spam_rating();       // 'excellent', 'good', 'fair', 'poor', 'bad'
```

### Comparison

[](#comparison)

```
$email1 = Email::parse( 'david+test@gmail.com' );
$email2 = Email::parse( 'david+other@gmail.com' );

$email1->equals( $email2 );       // false
$email1->equals_base( $email2 );  // true
$email1->same_domain( $email2 );  // true
```

### Country Detection

[](#country-detection)

```
Email::parse( 'user@example.co.uk' )?->country();  // 'GB'
Email::parse( 'user@example.de' )?->country();     // 'DE'
Email::parse( 'user@example.com' )?->country();    // null
```

### Array Output

[](#array-output)

```
$email = Email::parse( 'david@gmail.com' );

// Simplified (for APIs)
$email->to_simple_array();

// Comprehensive
$email->to_array();

// JSON
echo json_encode( $email );
```

Methods
-------

[](#methods)

### Getters

[](#getters)

MethodReturnsDescription`valid()``bool`Whether email is valid`original()``string`Original input string`normalized()``string`Lowercase, trimmed email`local()``string`Local part (before @)`domain()``string`Domain part (after @)`tld()``string`Top-level domain`base_local()``string`Local part without subaddress`base_address()``string`Email without subaddress`subaddress()``?string`Subaddress tag or null`country()``?string`ISO country code or null`digit_count()``int`Digits in local part### Detection

[](#detection-1)

MethodReturnsDescription`has_mx()``bool`Has valid MX records`is_subaddressed()``bool`Contains + subaddress`is_common_provider()``bool`Gmail, Yahoo, etc.`is_authority_provider()``bool`High-trust provider`supports_subaddressing()``bool`Provider supports + addressing`is_private()``bool`Localhost, internal, etc.`is_common_tld()``bool`.com, .org, .net, etc.`is_commercial_tld()``bool`.io, .co, .ai, etc.`is_role_based()``bool`admin@, info@, etc.`is_government()``bool`.gov, .gob, .gouv, etc.`is_educational()``bool`.edu, .ac.uk, etc.`is_military()``bool`.mil, military domains`is_anonymized()``bool`Contains \* or is placeholder`is_auto_generated()``bool`Random-looking local part`has_typo()``bool`Domain is a known typo`has_year()``bool`Contains year pattern`has_excessive_specials()``bool`Too many -, \_, or .`has_long_local()``bool`Local part &gt; 20 chars`has_long_domain()``bool`Domain name &gt; 15 chars### Matching

[](#matching)

MethodReturnsDescription`matches_any()``bool`Matches any pattern in list`matches_all()``bool`Matches all patterns in list`matches_pattern()``bool`Matches a single pattern`is_valid_pattern()``bool`Pattern is valid (static)`get_pattern_type()``?string`Get pattern type (static)`filter_valid_patterns()``array`Filter to valid patterns (static)### Typo Suggestions

[](#typo-suggestions)

MethodReturnsDescription`suggested_domain()``?string`Corrected domain or null`suggested_email()``?string`Full corrected email or null### Transformations

[](#transformations-1)

MethodReturnsDescription`with_local()``?static`New instance with different local`with_domain()``?static`New instance with different domain`with_subaddress()``?static`New instance with subaddress`without_subaddress()``?static`New instance without subaddress`with_tag()``?static`New instance with purpose+year tag### Output

[](#output)

MethodReturnsDescription`to_anonymized()``string``da***@gm***.com``to_masked()``string``d***d@gmail.com``to_hashed()``string`SHA-256 hashed`to_ascii()``string`Punycode encoded`to_placeholder()``string``deleted@site.invalid``to_simple_array()``array`Simplified for APIs`to_array()``array`Full analysis### Scoring

[](#scoring)

MethodReturnsDescription`spam_score()``int`0-100 suspicion score`spam_rating()``string`excellent/good/fair/poor/bad### Comparison

[](#comparison-1)

MethodReturnsDescription`equals()``bool`Exact match`equals_base()``bool`Base address match`same_domain()``bool`Domain matchRequirements
------------

[](#requirements)

- PHP 7.4+

License
-------

[](#license)

GPL-2.0-or-later

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance50

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity14

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/cd6eb8aff0903d87eb674d1ba3c5f3653899c0d7661504eb0deb7798ed86b643?d=identicon)[arraypress](/maintainers/arraypress)

---

Top Contributors

[![arraypress](https://avatars.githubusercontent.com/u/22668877?v=4)](https://github.com/arraypress "arraypress (11 commits)")

### Embed Badge

![Health badge](/badges/arraypress-email-utils/health.svg)

```
[![Health](https://phpackages.com/badges/arraypress-email-utils/health.svg)](https://phpackages.com/packages/arraypress-email-utils)
```

###  Alternatives

[webmozart/assert

Assertions to validate method input/output with nice error messages.

7.6k894.0M1.2k](/packages/webmozart-assert)[bensampo/laravel-enum

Simple, extensible and powerful enumeration implementation for Laravel.

2.0k15.9M104](/packages/bensampo-laravel-enum)[swaggest/json-schema

High definition PHP structures with JSON-schema based validation

48612.5M73](/packages/swaggest-json-schema)[stevebauman/purify

An HTML Purifier / Sanitizer for Laravel

5325.6M19](/packages/stevebauman-purify)[ashallendesign/laravel-config-validator

A package for validating your Laravel app's config.

217905.3k5](/packages/ashallendesign-laravel-config-validator)[crazybooot/base64-validation

Laravel validators for base64 encoded files

1341.9M8](/packages/crazybooot-base64-validation)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
