IMAP library
, (*1)
A PHP 5.4+ library to read and process e-mails over IMAP., (*2)
Installation
Make sure the PHP IMAP extension
is installed. For instance on Debian:, (*3)
# apt-get install php5-imap
The recommended way to install the IMAP library is through Composer:, (*4)
$ composer require ddeboer/imap
This command requires you to have Composer installed globally, as explained
in the installation chapter
of the Composer documentation., (*5)
Usage
Connect and Authenticate
use Ddeboer\Imap\Server;
$server = new Server('imap.gmail.com');
// $connection is instance of \Ddeboer\Imap\Connection
$connection = $server->authenticate('my_username', 'my_password');
Options
You can specify port, flags and parameters
to the server:, (*6)
$server = new Server(
$hostname, // required
$port, // defaults to 993
$flags, // defaults to '/imap/ssl/validate-cert'
$parameters
);
Mailboxes
Retrieve mailboxes (also known as mail folders) from the mail server and iterate
over them:, (*7)
$mailboxes = $connection->getMailboxes();
foreach ($mailboxes as $mailbox) {
// $mailbox is instance of \Ddeboer\Imap\Mailbox
printf('Mailbox %s has %s messages', $mailbox->getName(), $mailbox->count());
}
Or retrieve a specific mailbox:, (*8)
$mailbox = $connection->getMailbox('INBOX');
Delete a mailbox:, (*9)
$mailbox->delete();
Messages
Retrieve messages (e-mails) from a mailbox and iterate over them:, (*10)
$messages = $mailbox->getMessages();
foreach ($messages as $message) {
// $message is instance of \Ddeboer\Imap\Message
}
Searching for Messages
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);
Message Properties and Operations
Get message number and unique message id
in the form ...:, (*11)
$message->getNumber();
$message->getId();
Get other message properties:, (*12)
$message->getSubject();
$message->getFrom();
$message->getTo();
$message->getDate();
$message->isAnswered();
$message->isDeleted();
$message->isDraft();
$message->isSeen();
Get message headers as a \Ddeboer\Imap\Message\Headers object:, (*13)
$message->getHeaders();
Get message body as HTML or plain text:, (*14)
$message->getBodyHtml();
$message->getBodyText();
Reading the message body marks the message as seen. If you want to keep the
message unseen:, (*15)
$message->keepUnseen()->getBodyHtml();
Move a message to another mailbox:, (*16)
$mailbox = $connection->getMailbox('another-mailbox');
$message->move($mailbox);
Deleting messages:, (*17)
$mailbox->getMessage(1)->delete();
$mailbox->getMessage(2)->delete();
$mailbox->expunge();
Message Attachments
Get message attachments (both inline and attached) and iterate over them:, (*18)
$attachments = $message->getAttachments();
foreach ($attachments as $attachment) {
// $attachment is instance of \Ddeboer\Imap\Message\Attachment
}
Download a message attachment to a local file:, (*19)
// getDecodedContent() decodes the attachment’s contents automatically:
file_put_contents(
'/my/local/dir/' . $attachment->getFilename(),
$attachment->getDecodedContent()
);
Running the Tests
This library is functionally tested on Travis CI
against the Gmail IMAP server., (*20)
If you have your own IMAP (test) account, you can run the tests locally by
providing your IMAP (e.g., Gmail) credentials:, (*21)
$ composer install --dev
$ EMAIL_USERNAME="your_username" EMAIL_PASSWORD="your_password" vendor/bin/phpunit
You can also set an EMAIL_SERVER variable, which defaults to imap.gmail.com:, (*22)
$ EMAIL_USERNAME="your_username" EMAIL_PASSWORD="your_password" EMAIL_SERVER="imap.you.com" vendor/bin/phpunit
Wallogit.com
