README

一个用于通过 IMAP 读取和处理电子邮件的 PHP 5.4+ 库。

安装

确保已安装 PHP IMAP 扩展。例如，在 Debian 上

# apt-get install php5-imap

安装 IMAP 库的推荐方法是使用 Composer

$ composer require ddeboer/imap

此命令要求您全局安装 Composer，如 Composer 文档中的 安装章节 所述。

使用方法

连接和认证

use Ddeboer\Imap\Server;

$server = new Server('imap.gmail.com');

// $connection is instance of \Ddeboer\Imap\Connection
$connection = $server->authenticate('my_username', 'my_password');

您可以指定端口、标志和参数到服务器

$server = new Server(
    $hostname, // required
    $port,     // defaults to 993
    $flags,    // defaults to '/imap/ssl/validate-cert'
    $parameters
);

邮箱

从邮件服务器检索邮箱（也称为邮件文件夹）并遍历它们

$mailboxes = $connection->getMailboxes();

foreach ($mailboxes as $mailbox) {
    // $mailbox is instance of \Ddeboer\Imap\Mailbox
    printf('Mailbox %s has %s messages', $mailbox->getName(), $mailbox->count());
}

或检索特定的邮箱

$mailbox = $connection->getMailbox('INBOX');

删除邮箱

$mailbox->delete();

消息

从邮箱检索消息（电子邮件）并遍历它们

$messages = $mailbox->getMessages();

foreach ($messages as $message) {
    // $message is instance of \Ddeboer\Imap\Message
}

use Ddeboer\Imap\SearchExpression;
use Ddeboer\Imap\Search\Email\To;
use Ddeboer\Imap\Search\Text\Body;

$search = new SearchExpression();
$search->addCondition(new To('me@here.com'))
    ->addCondition(new Body('contents'))
;

$messages = $mailbox->getMessages($search);

获取消息编号和唯一的 消息 id，格式为 <...>

$message->getNumber();
$message->getId();

获取其他消息属性

$message->getSubject();
$message->getFrom();
$message->getTo();
$message->getDate();
$message->isAnswered();
$message->isDeleted();
$message->isDraft();
$message->isSeen();

获取消息头作为 \Ddeboer\Imap\Message\Headers 对象

$message->getHeaders();

获取消息体作为 HTML 或纯文本

$message->getBodyHtml();
$message->getBodyText();

读取消息体会将该消息标记为已读。如果您想保留消息未读状态

$message->keepUnseen()->getBodyHtml();

将消息移动到另一个邮箱

$mailbox = $connection->getMailbox('another-mailbox');
$message->move($mailbox);

删除消息

$mailbox->getMessage(1)->delete();
$mailbox->getMessage(2)->delete();
$mailbox->expunge();

消息附件

获取消息附件（包括内联和附件）并遍历它们

$attachments = $message->getAttachments();

foreach ($attachments as $attachment) {
    // $attachment is instance of \Ddeboer\Imap\Message\Attachment
}

将消息附件下载到本地文件

// getDecodedContent() decodes the attachment’s contents automatically:
file_put_contents(
    '/my/local/dir/' . $attachment->getFilename(),
    $attachment->getDecodedContent()
);

运行测试

此库已在 Travis CI 上对 Gmail IMAP 服务器进行了功能测试。

如果您有自己的 IMAP（测试）账户，您可以通过提供您的 IMAP（例如，Gmail）凭据在本地运行测试

$ composer install --dev
$ EMAIL_USERNAME="your_username" EMAIL_PASSWORD="your_password" vendor/bin/phpunit

您还可以设置一个 EMAIL_SERVER 变量，默认为 imap.gmail.com

$ EMAIL_USERNAME="your_username" EMAIL_PASSWORD="your_password" EMAIL_SERVER="imap.you.com" vendor/bin/phpunit