PHP Email Parser 项目技术文档

1. 安装指南

1.1 项目状态

本项目已不再维护，建议仅在小型项目中使用，尤其是当你明确知道将要解析的电子邮件格式时。由于该项目无法处理广泛的电子邮件格式，使用时需自行承担风险。

1.2 依赖安装

如果你处理的是非英语语言的电子邮件，建议安装 IMAP PHP 扩展。Plancake PHP Email Parser 会自动检测并使用该扩展以获得更好的解析效果。

1.3 安装步骤

1. 下载项目代码。
2. 将项目文件放置在你的项目目录中。
3. 确保你的 PHP 环境已安装必要的扩展（如 IMAP）。

2. 项目的使用说明

2.1 基本使用

Plancake PHP Email Parser 允许你轻松解析电子邮件的内容（包括头部和正文）。以下是一个基本的使用示例：

$emailPath = "/var/mail/spool/dan/new/12323344323234234234";
$emailParser = new PlancakeEmailParser(file_get_contents($emailPath));

// 获取邮件头部信息
$emailTo = $emailParser->getTo();
$emailSubject = $emailParser->getSubject();
$emailCc = $emailParser->getCc();

// 获取特定头部信息
$emailDeliveredToHeader = $emailParser->getHeader('Delivered-To');

// 获取邮件正文
$emailBody = $emailParser->getPlainBody();

2.2 注意事项

• 项目已不再维护，建议仅在小型项目中使用。
• 处理非英语语言的电子邮件时，建议安装 IMAP PHP 扩展以获得更好的解析效果。

3. 项目API使用文档

3.1 获取邮件头部信息

• getTo(): 获取邮件的收件人信息。
• getSubject(): 获取邮件的主题。
• getCc(): 获取邮件的抄送信息。
• getHeader(string $headerName): 获取指定名称的邮件头部信息。

3.2 获取邮件正文

• getPlainBody(): 获取邮件的纯文本正文。

4. 项目安装方式

4.1 手动安装

1. 下载项目代码并解压。
2. 将解压后的文件放置在你的项目目录中。
3. 确保你的 PHP 环境已安装必要的扩展（如 IMAP）。

4.2 使用 Composer 安装（可选）

虽然项目已不再维护，但你可以通过 Composer 安装：

composer require daniele-occhipinti/php-email-parser

4.3 注意事项

• 由于项目已不再维护，建议仅在小型项目中使用。
• 处理非英语语言的电子邮件时，建议安装 IMAP PHP 扩展以获得更好的解析效果。

---

通过以上文档，你可以了解如何安装和使用 Plancake PHP Email Parser 项目。请注意，项目已不再维护，使用时需自行承担风险。