willdurand/email-reply-parser

PHP版本的GitHub的EmailReplyParser库的移植

2.10.0 2022-01-30 20:56 UTC

README

GitHub Actions Total Downloads Latest Stable Version

EmailReplyParser 是一个PHP库,用于解析纯文本电子邮件内容,基于GitHub的用Ruby编写的 email_reply_parser 库。

安装

推荐通过 Composer 安装 EmailReplyParser。

composer require willdurand/email-reply-parser

使用

实例化一个 EmailParser 对象并解析您的电子邮件

<?php

use EmailReplyParser\Parser\EmailParser;

$email = (new EmailParser())->parse($emailContent);

您将获得一个包含一系列 Fragment 对象的 Email 对象。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);

已知问题

引用的标题

如果存在额外的换行符,则无法获取引用的标题

On <date>, <author> wrote:

> blah

此外,如果电子邮件客户端将其拆分成多行,也无法获取。GMail 会将超过80个字符的任何行拆分。

On <date>, <author>
wrote:
> blah

上述 On ....wrote: 可以用以下正则表达式清理

$fragment_without_date_author = preg_replace(
  '/\nOn(.*?)wrote:(.*?)$/si',
  "",
  $fragment->getContent()
);

但是请注意,我们正在寻找“on”和“wrote”。因此,它不会用于其他语言。

可能的解决方案:删除 "reply@reply.github.com" 行...

奇怪的签名

-_ 开头的行有时标记签名的开始

Hello

--
Rick

并非所有人都会遵循这个约定

Hello

Mr Rick Olson
Galactic President Superstar Mc Awesomeville
GitHub

**********************DISCLAIMER***********************************
* Note: blah blah blah                                            *
**********************DISCLAIMER***********************************

奇怪的引用

显然,使用 > 前缀也不是通用的

Hello

--
Rick

________________________________________
From: Bob [reply@reply.github.com]
Sent: Monday, March 14, 2011 6:16 PM
To: Rick

单元测试

使用Composer设置测试套件

$ composer install

使用PHPUnit运行它

$ ./vendor/bin/simple-phpunit

贡献

参见CONTRIBUTING文件。

致谢

  • GitHub
  • William Durand

许可证

EmailReplyParser 在MIT许可证下发布。有关详细信息,请参阅捆绑的LICENSE文件。