README

可测试且符合PSR规范的mail mime解析器，是PHP的imap*函数和Pear库的替代品，用于读取以Internet Message Format（RFC 822）格式编写的消息（以及后续修订RFC 2822、RFC 5322）。

本项目目标是

• 编写良好
• 符合标准但具有容错性
• 尽可能进行测试

要将其包含到项目中使用，请通过composer安装

composer require zbateson/mail-mime-parser

赞助商

向所有赞助商表示衷心的感谢。<3

如果本项目对您有所帮助，请考虑赞助我。

PHP 7支持已弃用

从mail-mime-parser 3.0版本开始，已弃用对PHP 7的支持。

3.0版本新增功能

3.0版本中的大多数更改是'后端'更改，例如切换到PHP-DI进行依赖注入，基本使用不应受到影响。

在3.0版本中，'getAllParts'类方法包含注释部分。

增加了错误、验证和日志支持。

有关更改的完整列表，请访问3.0升级指南和使用指南。

要求

MailMimeParser需要PHP 8.0或更高版本。已在PHP 8.0、8.1、8.2和8.3上进行了测试。

使用方法

use ZBateson\MailMimeParser\MailMimeParser;
use ZBateson\MailMimeParser\Message;
use ZBateson\MailMimeParser\Header\HeaderConsts;

// use an instance of MailMimeParser as a class dependency
$mailParser = new MailMimeParser();

// parse() accepts a string, resource or Psr7 StreamInterface
// pass `true` as the second argument to attach the passed $handle and close
// it when the returned IMessage is destroyed.
$handle = fopen('file.mime', 'r');
$message = $mailParser->parse($handle, false);         // returns `IMessage`

// OR: use this procedurally (Message::from also accepts a string,
// resource or Psr7 StreamInterface
// true or false as second parameter doesn't matter if passing a string.
$string = "Content-Type: text/plain\r\nSubject: Test\r\n\r\nMessage";
$message = Message::from($string, false);

echo $message->getHeaderValue(HeaderConsts::FROM);     // [email protected]
echo $message
    ->getHeader(HeaderConsts::FROM)                    // AddressHeader
    ->getPersonName();                                 // Person Name
echo $message->getSubject();                           // The email's subject
echo $message
    ->getHeader(HeaderConsts::TO)                      // also AddressHeader
    ->getAddresses()[0]                                // AddressPart
    ->getPersonName();                                 // Person Name
echo $message
    ->getHeader(HeaderConsts::CC)                      // also AddressHeader
    ->getAddresses()[0]                                // AddressPart
    ->getEmail();                                      // [email protected]

echo $message->getTextContent();                       // or getHtmlContent()

echo $message->getHeader('X-Foo');                     // for custom or undocumented headers

$att = $message->getAttachmentPart(0);                 // first attachment
echo $att->getHeaderValue(HeaderConsts::CONTENT_TYPE); // e.g. "text/plain"
echo $att->getHeaderParameter(                         // value of "charset" part
    'content-type',
    'charset'
);
echo $att->getContent();                               // get the attached file's contents
$stream = $att->getContentStream();                    // the file is decoded automatically
$dest = \GuzzleHttp\Psr7\stream_for(
    fopen('my-file.ext')
);
\GuzzleHttp\Psr7\copy_to_stream(
    $stream, $dest
);
// OR: more simply if saving or copying to another stream
$att->saveContent('my-file.ext');               // writes to my-file.ext
$att->saveContent($stream);                     // copies to the stream

// close only when $message is no longer being used.
fclose($handle);

文档

• 使用指南
• API参考

升级指南

• 1.x升级指南
• 2.x升级指南
• 3.x升级指南

许可证

BSD许可证 - 请参阅许可协议。