effectra/email-address-formatter

The Effectra Email Address Formatter package.

dev-main 2025-10-02 20:15 UTC

MIT

• Mohammed Taha [BMT]

README

A lightweight PHP package for representing and formatting email addresses with optional names.
It provides validation, parsing, and factory methods to work with email addresses in a clean and consistent way.

Features

• Represent an email address with an optional name.
• Create an Address object from a raw string (e.g., "John Doe <[e-mail]>").
• Validate email addresses.
• Format email addresses in a standard string format.
• Create multiple Address instances from an array of data.
• Follows SOLID principles with AddressInterface.

Installation

composer require effectra/email-address-formatter

Usage

Basic Example

use Effectra\EmailAddressFormatter\Address;

$address = new Address("[e-mail]", "John Doe");

echo $address->getEmail(); // [e-mail]
echo $address->getName();  // John Doe
echo $address->format();   // John Doe <[e-mail]>

Create from String

use Effectra\EmailAddressFormatter\Address;

$address = Address::createFrom("Jane Doe <[e-mail]>");

echo $address->getEmail(); // [e-mail]
echo $address->getName();  // Jane Doe

Using AddressFactory

use Effectra\EmailAddressFormatter\AddressFactory;

// Single address
$address = AddressFactory::create("[e-mail]", "Mike");

// Multiple addresses
$addresses = AddressFactory::createFromArray([
    "[e-mail]",
    ["email" => "[e-mail]", "name" => "David"],
    ["email" => "[e-mail]"] // name is optional
]);

foreach ($addresses as $addr) {
    echo $addr->format() . PHP_EOL;
}
// Output:
// [e-mail] <[e-mail]>
// David <[e-mail]>
// [e-mail] <[e-mail]>

Validation

use Effectra\EmailAddressFormatter\Address;

if (Address::emailValidation("[e-mail]")) {
    echo "Valid email!";
} else {
    echo "Invalid email!";
}

API Reference

Address class

• __construct(string $email, string $name = '')
• static createFrom(string $addressText): static
• getName(): string
• getEmail(): string
• static emailValidation(string $email): bool
• format(): string
• __toString(): string

AddressFactory class

• static create(string $email, string $name = ''): AddressInterface
• static createFromArray(array $data): AddressInterface[]

AddressInterface

• getName(): string
• getEmail(): string
• static emailValidation(string $email): bool
• format(): string

Example Output

$address = new Address("[e-mail]", "Alex");

echo $address; 
// Output: Alex <[e-mail]>

License

This package is open-source and available under the MIT License.