bigpaulie/imap

A PHP wrapper class for PHP's IMAP-related email handling functions.

Imap

This library is an improvement of Jeff Geerling's project tailored specifically for my needs at the moment., _(*1)

Keep in mind that this is still a work in progress so radical changes may occurr in time., _(*2)

Installation

You can install this library via composer by running the command bellow or you can clone the repository., _(*3)

composer require bigpaulie/imap

Usage

A mailbox in the context of this library is referring to a directory of your email account., _(*4)

Connect to an IMAP account by creating a new Imap object with the required parameters:, _(*5)

$host = 'imap.example.com';
$user = 'johndoe';
$pass = '12345';
$port = 993;
$ssl = true;
$folder = 'INBOX';
$server = new Imap($host, $user, $pass, $port, $ssl, $folder);

Obtain a mailbox object

/** @var Mailbox $mailbox */
$mailbox = $server->getMailbox();

If you want to access another directory, _(*6)

/** @var Mailbox $mailbox */
$mailbox = $server->getMailbox('SPAM');

Mailbox info

/** @var array $info */
$info = $mailbox->getInfo();

Obtain a list of messages within a specific mailbox

/** @var Message[] $messages */
$messages = $mailbox->getMessages();

You can then iterate through the array of messages, _(*7)

/** @var Message $message */
foreach ($messages as $message) {
    $subject = $message->getSubject();
    $messageBody = $message->getBody();
}

Create a search criteria

You can obtain only certain messages if you want to., _(*8)

Only undeleted messages, _(*9)

/** @var Search $criteria */
$criteria = new Search();
$criteria->setCriteria(Search::UNDELETED);

/** @var Message[] $messages */
$messages = $mailbox->getMessages($criteria);

You can add multiple search criterias for example :, _(*10)

/** @var Search $criteria */
$criteria = new Search();
$criteria->setCriteria(Search::UNDELETED);
$criteria->setCriteria(Search::FROM, "John Doe");
$criteria->setCriteria(Search::KEYWORD, "candy");

/** @var Message[] $messages */
$messages = $mailbox->getMessages($criteria);

Search criterias can be chained together:, _(*11)

/** @var Search $criteria */
$criteria = new Search();
$criteria->setCriteria(Search::UNDELETED)
    ->setCriteria(Search::FROM, "John Doe")
    ->setCriteria(Search::KEYWORD, "candy");

/** @var Message[] $messages */
$messages = $mailbox->getMessages($criteria);

Moving messages

You can move messages from one mailbox to another very easily, _(*12)

if ($mailbox->moveMessage($message, 'SPAM')) {
    echo "Message moved successfuly";
}

Copying messages

Copying messages is as easy as moving them, _(*13)

if ($mailbox->copyMessage($message, 'SPAM')) {
    echo "Message moved successfuly";
}

Deleting messages

$mailbox->deleteMessage($message);

Disconnecting from the server

$server->disconnect();

Contributions

If you want to make a contribution and improve the library or you noticed a bug you are more than welcome to do so., _(*14)

For contributors just fork, code and submit a pull request., _(*15)

Please maintain the coding style and testing patterns., _(*16)