README

实现 php-extended/php-email-address-interface 库的库。

安装

此库的安装通过 composer 完成，所有类的自动加载通过它们的自动加载器完成。

• 从他们的网站下载 composer.phar。
• 然后运行以下命令以将此库作为依赖项安装
• php composer.phar require php-extended/php-email-address-object ^7

基本用法

要使用此接口，您可以执行以下操作

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('example.com')); // example@example.com
$email->__toString(); // example@example.com

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

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

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

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

$emails = $mailboxGroupList->collectEmailAddresses();
echo implode(', ', iterator_to_array($emails)); // echo "example@example.com, example2@example.com"

要解析电子邮件地址，您可以执行以下操作

use PhpExtended\Email\EmailAddressParser;

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

或者，对于请求的标题

use PhpExtended\Email\MailboxGroupListParser;

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

echo $list->collectEmailAddresses();
// echoes "toto@example.com, toto2@example.com, tata@example.com"

测试数据

此库已在以下数据集上进行测试

• https://gist.github.com/cjaoude/fd9910626629b53c4d25
• https://github.com/dominicsayers/isemail/blob/master/test/tests.xml
• https://en.wikipedia.org/wiki/Email_address

如果您可以找到其他用于测试的数据集，请提交一个问题，我将尝试测试此库。

许可证

MIT (见许可证文件).