EmailReplyParser 技术文档

1. 安装指南

推荐使用 Composer 来安装 EmailReplyParser。在命令行中执行以下命令：

composer require willdurand/email-reply-parser

2. 项目使用说明

EmailReplyParser 是一个 PHP 库，用于解析纯文本电子邮件内容。以下是如何使用该库的基本步骤：

首先，实例化一个 EmailParser 对象并解析你的电子邮件：

<?php

use EmailReplyParser\Parser\EmailParser;

$emailContent = '...'; // 你的电子邮件内容
$email = (new EmailParser())->parse($emailContent);

解析完成后，你会得到一个 Email 对象，其中包含一系列 Fragment 对象。Email 类提供了以下两种方法：

• getFragments(): 返回所有片段；
• getVisibleText(): 返回一个表示“可见”内容的字符串。

Fragment 对象表示电子邮件内容的一部分，并提供了以下 API：

<?php

$fragment = current($email->getFragments());

$fragment->getContent(); // 获取片段内容

$fragment->isSignature(); // 判断片段是否为签名

$fragment->isQuoted(); // 判断片段是否被引用

$fragment->isHidden(); // 判断片段是否隐藏

$fragment->isEmpty(); // 判断片段是否为空

另外，你也可以直接使用 EmailReplyParser 来解析电子邮件或获取其可见内容：

$email = \EmailReplyParser\EmailReplyParser::read($emailContent);

$visibleText = \EmailReplyParser\EmailReplyParser::parseReply($emailContent);

3. 项目API使用文档

以下是 EmailReplyParser 的主要 API：

• EmailParser::parse($emailContent): 解析电子邮件内容，返回一个 Email 对象；
• EmailParser::read($emailContent): 解析电子邮件内容，返回一个包含 Email 对象的数组；
• Email::getFragments(): 返回 Email 对象中的所有 Fragment 对象；
• Email::getVisibleText(): 返回 Email 对象的可见文本；
• Fragment::getContent(): 获取片段内容；
• Fragment::isSignature(): 判断片段是否为签名；
• Fragment::isQuoted(): 判断片段是否被引用；
• Fragment::isHidden(): 判断片段是否隐藏；
• Fragment::isEmpty(): 判断片段是否为空。

4. 项目安装方式

项目安装方式已在“安装指南”一节中说明，请参考第1节内容。