A library that implements the php-extended/php-email-address-interface interface library.


A library that implements the php-extended/php-email-address-interface library.

coverage build status


The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.

  • Download composer.phar from their website.
  • Then run the following command to install this library as dependency :
  • php composer.phar php-extended/php-email-address-object ^7

Basic Usage

To use this interface, you may do the following :

use PhpExtended\Domain\Domain;
use PhpExtended\Email\EmailAddress;
use PhpExtended\Email\Mailbox;
use PhpExtended\Email\MailboxGroup;
use PhpExtended\Email\MailboxGroupList;

$email = new EmailAddress('example', new Domain('')); //
$email->__toString(); //

$mailbox = new Mailbox($email, 'Example, Inc');
$mailbox->__toString(); // "Example, Inc" <>

$mailboxList = new MailboxList([$mailbox]);
$mailboxList->__toString(); // "Example, Inc" <>

$mailboxGroup = new MailboxGroup($mailboxList, 'All Examples');
$mailboxGroup->__toString(); // "All Examples": "Example, Inc" <>

$mailboxGroupList = new MailboxGroupList([$mailboxGroup]);
$mailboxGroupList = $mailboxGroupList->withEmailAddress(new EmailAddress('example2', ''), 'Example2, Inc', 'Other Examples');
$mailboxGroupList->__toString(); // "All Examples": "Example, Inc" <>; "Other Examples": "Example2, Inc" <>

$emails = $mailboxGroupList->collectEmailAddresses();
echo implode(', ', iterator_to_array($emails)); // echo ","

To parse email addresses, you may do the following :

use PhpExtended\Email\EmailAddressParser;

$parser = new EmailAddressParser();
$email = $parser->parse('');
// $email instanceof \PhpExtended\Email\EmailAddress

or, for headers of requests :

use PhpExtended\Email\MailboxGroupListParser;

$parser = new MailboxGroupListParser();
$list = $parser->parse('Group: Toto; Group2:, "Tata \""');
// $list instanceof \PhpExtended\Email\MailboxGroupList
// Group :
//    Toto <>
// Group 2:
//         <>
//    Tata " <> // <- The display name is 'Tata "' and is properly quoted and escaped on canonicalRepresentation

echo $list->collectEmailAddresses();
// echoes ",,"

Test data

This library was tested against the following data sets:

If you can find other data sets to test against, just file an issue and i will try to test this library against it.


MIT (See license file).