IMAP mail downloader

1.3.0 2020-02-03 08:33 UTC

This package is auto-updated.

Last update: 2024-06-04 22:39:05 UTC


Library for fetching inbox mails and processing them.

Build Status Code Climate Test Coverage Dependency Status

Latest Stable Version Latest Unstable Version License


Install package via composer:

$ composer require tomaj/imap-mail-downloader


Basic usage in php:

use Tomaj\ImapMailDownloader\Downloader;
use Tomaj\ImapMailDownloader\MailCriteria;
use Tomaj\ImapMailDownloader\Email;

$downloader = new Downloader('*imap host*', *port*, '*username*', '*password*');

$criteria = new MailCriteria();
$downloader->fetch($criteria, function(Email $email) {
	return true;

You can return false in callback function. In this case this email will be fetched also in next time. For processing emails you will need to create folder INBOX/processed. There is possiblity to setup criteria for fetching emails with MailCriteria. More information in source code.

Library is extremelly simple. Usefull for processing some notification emails. For complex usecases you will need to use native php imap_ functions.