particlebits/imap

PHP class to access an IMAP mailbox. Specifically uses the Zend library and not the IMAP extension.

Pb\Imap

Pb\Imap is a library for downloading and parsing IMAP email messages. For performance reasons, the PHP IMAP extension is specifically not used, in favor of the Laminas Mail library., _(*1)

Separate forks of the Laminas Mail and Laminas Mime libraries are used and kept as up to date as possible. These forks are needed to make minor but necessary updates that wouldn't be approved in time or at all by the Laminas maintainers., _(*2)

Memory performance is the goal of this library and it's been stabilized and reduced as much as possible. Depending on file attachment downloads, this application uses on average 10-20 MB of memory, with a peak of up to 75-100 MB during large attachment downloads., _(*3)

Features

• Connect to mailbox via IMAP
• Get a listing of all folders
• Download email messages and save attachments to disk
• Search emails by custom criteria
• Get status information on each folder

Installation by Composer

{
  "require": {
    "particlebits/imap": "^2.1"
  }
}

or, _(*4)

$> composer require particlebits/imap ^2.1

Usage Example

$mailbox = new \Pb\Imap\Mailbox(
    'imap.gmail.com',
    'something@gmail.com',
    '**********',
    'INBOX',
    __DIR__ .'/attachments',
    [
        \Pb\Imap\Mailbox::OPT_DEBUG_MODE => true
    ]);
$messageIds = $mailbox->searchMailBox('ALL');

foreach ($messageIds as $messageId) {
    $message = $mailbox->getMessage($messageId);
    print_r($message);
    print_r($message->getAttachments());
}

Available Options

You can use the following options in the final argument of the Mailbox constructor:, _(*5)

• OPT_DEBUG_MODE This will write memory info to the screen
• OPT_SKIP_ATTACHMENTS Skips downloading message attachments. Useful for saving disk space.

Notes

This project originally used the PHP IMAP extension for fetching and parsing email messages. The extension is not very memory efficient for long-running processes, which is my intended use. Instead, this library uses the Laminas Mail package. Laminas Mail retrieves messages through a socket connection and parses the headers. \Pb\Imap takes this raw message object and converts into something more user-friendly., _(*6)

For more examples see the scripts inside the tests/ folder., _(*7)