README

适用于 PHP 7.1+（mailparse 扩展包装器）的完全测试的电子邮件解析器。

在性能、外文字符编码、附件处理和使用便捷性方面，这是最有效的 PHP 电子邮件解析器。遵循 Internet 消息格式 RFC 822、2822、5322。

为什么？

此扩展可用于...

• 解析和读取来自 Postfix 的电子邮件
• 读取消息（文件扩展名：eml）
• 创建 webmail
• 将电子邮件信息（如主题、HTML 正文、附件等）存储到数据库中

它可靠吗？

是的。所有已知问题都已重现、修复和测试。

我们使用 Travis CI 来帮助确保代码质量。您可以在下面看到实时统计信息

如何安装它？

最简单的方法是通过 Composer。

要安装 PHP MIME Mail Parser 的最新版本，请运行以下命令

composer require php-mime-mail-parser/php-mime-mail-parser

要求

以下版本的 PHP 都受支持

• PHP 7.1
• PHP 7.2
• PHP 7.3

以前的版本

请确保已正确安装 mailparse 扩展（https://php.ac.cn/manual/en/book.mailparse.php）。命令行 php -m | grep mailparse 需要返回 "mailparse"。

安装 mailparse 扩展

Ubuntu、Debian 及其衍生版本

sudo apt install php-cli php-mailparse

其他平台

sudo apt install php-cli php-pear php-dev php-mbstring
pecl install mailparse

从源代码安装

AAAAMMDD 应该是 php-config --extension-dir

git clone https://github.com/php/pecl-mail-mailparse.git
cd pecl-mail-mailparse
phpize
./configure
sed -i 's/#if\s!HAVE_MBSTRING/#ifndef MBFL_MBFILTER_H/' ./mailparse.c
make
sudo mv modules/mailparse.so /usr/lib/php/AAAAMMDD/
echo "extension=mailparse.so" | sudo tee /etc/php/7.1/mods-available/mailparse.ini
sudo phpenmod mailparse

Windows

您需要从 http://pecl.php.net/package/mailparse 下载 mailparse DLL，并将 "extension=php_mailparse.dll" 行添加到相应的 php.ini 中。

如何使用它？

加载电子邮件

您可以通过四种不同的方式加载电子邮件。您只需要使用以下四种方式之一。

require_once __DIR__.'/vendor/autoload.php';

$path = 'path/to/email.eml';
$parser = new PhpMimeMailParser\Parser();

// 1. Specify a file path (string)
$parser->setPath($path); 

// 2. Specify the raw mime mail text (string)
$parser->setText(file_get_contents($path));

// 3. Specify a php file resource (stream)
$parser->setStream(fopen($path, "r"));

// 4.  Specify a stream to work with mail server (stream)
$parser->setStream(fopen("php://stdin", "r"));

获取消息的元数据

获取发件人和收件人

$rawHeaderTo = $parser->getHeader('to');
// return "test" <test@example.com>, "test2" <test2@example.com>

$arrayHeaderTo = $parser->getAddresses('to');
// return [["display"=>"test", "address"=>"test@example.com", false]]

$rawHeaderFrom = $parser->getHeader('from');
// return "test" <test@example.com>

$arrayHeaderFrom = $parser->getAddresses('from');
// return [["display"=>"test", "address"=>"test@example.com", "is_group"=>false]]

获取主题

$subject = $parser->getHeader('subject');

获取其他标题

$stringHeaders = $parser->getHeadersRaw();
// return all headers as a string, no charset conversion

$arrayHeaders = $parser->getHeaders();
// return all headers as an array, with charset conversion

获取消息正文

$text = $parser->getMessageBody('text');
// return the text version

$html = $parser->getMessageBody('html');
// return the html version

$htmlEmbedded = $parser->getMessageBody('htmlEmbedded');
// return the html version with the embedded contents like images

获取附件

将所有附件保存到目录中

$parser->saveAttachments('/path/to/save/attachments/');
// return all attachments saved in the directory (include inline attachments)

$parser->saveAttachments('/path/to/save/attachments/', false);
// return all attachments saved in the directory (exclude inline attachments)

获取所有附件

$attachments = $parser->getAttachments();
// return an array of all attachments (include inline attachments)

$attachments = $parser->getAttachments(false);
// return an array of all attachments (exclude inline attachments)

遍历所有附件

foreach ($attachments as $attachment) {
    echo 'Filename : '.$attachment->getFilename().'<br />';
    // return logo.jpg
    
    echo 'Filesize : '.filesize($attach_dir.$attachment->getFilename()).'<br />';
    // return 1000
    
    echo 'Filetype : '.$attachment->getContentType().'<br />';
    // return image/jpeg
    
    echo 'MIME part string : '.$attachment->getMimePartStr().'<br />';
    // return the whole MIME part of the attachment
}

Postfix 配置以管理来自邮件服务器的电子邮件

接下来，您需要将电子邮件转发到上面的脚本。为此，我将使用 Postfix 作为邮件服务器，您需要配置 /etc/postfix/master.cf

在文件末尾添加此行（指定 myhook 将所有电子邮件发送到 test.php 脚本）

myhook unix - n n - - pipe
  				flags=F user=www-data argv=php -c /etc/php5/apache2/php.ini -f /var/www/test.php ${sender} ${size} ${recipient}

编辑此行（注册 myhook）

smtp      inet  n       -       -       -       -       smtpd
        			-o content_filter=myhook:dummy

PHP 脚本必须使用第四种方法才能与这种配置一起工作。

最后，最简单的方法是使用我的 SaaS https://mailcare.io

我可以贡献力量吗？

请随时贡献力量！

git clone https://github.com/php-mime-mail-parser/php-mime-mail-parser
cd php-mime-mail-parser
composer install
./vendor/bin/phpunit

如果您报告了一个问题，请提供触发此问题的原始电子邮件。这有助于我们更快地重现并修复问题。

许可证

php-mime-mail-parser/php-mime-mail-parser 是开源软件，许可证为 MIT 许可证