PHPackages benpoulson/php-imap - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Mail & Notifications](/categories/mail) 4. / 5. benpoulson/php-imap ActiveLibrary[Mail & Notifications](/categories/mail) benpoulson/php-imap =================== Manage mailboxes, filter/get/delete emails in PHP (supports IMAP/POP3/NNTP) 3.0.28(6y ago)01.8kMITPHPPHP >=5.6 Since Apr 20Pushed 6y agoCompare [ Source](https://github.com/benpoulson/php-imap)[ Packagist](https://packagist.org/packages/benpoulson/php-imap)[ Docs](https://github.com/barbushin/php-imap)[ RSS](/packages/benpoulson-php-imap/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (2)Versions (49)Used By (0) PHP IMAP ======== [](#php-imap) [![GitHub release](https://camo.githubusercontent.com/dba4505d51134c130aa4efdf9f4443efb8d74630ebc17b011e491ef7d3937201/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f62617262757368696e2f7068702d696d61702e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/php-imap/php-imap)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Packagist](https://camo.githubusercontent.com/e02c7304601b7b149a2fca09d0d6f30502710a288b844cac1ce298f5b7c0a883/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7068702d696d61702f7068702d696d61702e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/php-imap/php-imap)[![Build Status](https://camo.githubusercontent.com/547350fe4b5151b993ca2a7fa9ab99d63d80f3e6296b1d8d8e656422bfc9a344/68747470733a2f2f7472617669732d63692e6f72672f62617262757368696e2f7068702d696d61702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/barbushin/php-imap)[![Supported PHP Version](https://camo.githubusercontent.com/04862ea81044788595ac0ec4e90b032e51b5391993a7a37fd004cc511f0e2544/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f7068702d696d61702f7068702d696d61702f332e302e382e737667)](README.md)[![Maintainability](https://camo.githubusercontent.com/95f21b236e21ab56acc516bd58422863bbccda6c15e83795dfe89b32f986956b/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f30326637326134666436393563623765323937362f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/barbushin/php-imap/maintainability)[![Coverage](https://camo.githubusercontent.com/735583e18168758176aa53899e235a249acabb9d11cbd72a026eee4979ba660e/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f30326637326134666436393563623765323937362f746573745f636f766572616765)](https://codeclimate.com/github/barbushin/php-imap/test_coverage) Initially released in December 2012, the PHP IMAP Mailbox is a powerful and open source library to connect to a mailbox by POP3, IMAP and NNTP using the PHP IMAP extension. This library allows you to fetch emails from your email server. Extend the functionality or create powerful web applications to handle your incoming emails. ### Features [](#features) - Connect to mailbox by POP3/IMAP/NNTP, using [PHP IMAP extension](http://php.net/manual/book.imap.php) - Get emails with attachments and inline images - Get emails filtered or sorted by custom criteria - Mark emails as seen/unseen - Delete emails - Manage mailbox folders ### Requirements [](#requirements) - PHP 5.6, 7.0, 7.1, 7.2 or 7.3 - PHP `imap` extension must be present; so make sure this line is active in your php.ini: `extension=php_imap.dll` - PHP `mbstring` extension must be present; so make sure this line is active in your php.ini: `extension=php_mbstring.dll` - PHP `iconv` extension must be present, if `mbstring` is not available; so make sure this line is active in your php.ini: `extension=php_iconv.dll` ### Installation by Composer [](#installation-by-composer) Install the [latest available release](https://github.com/barbushin/php-imap/releases): ``` $ composer require php-imap/php-imap ``` Install the latest available and stable source code from `master`, which is may not released / tagged yet: ``` $ composer require php-imap/php-imap ``` Install the latest available and may unstable source code from `develop`, which is may not properly tested yet: ``` $ composer require php-imap/php-imap:dev-develop ``` ### PHPUnit Tests [](#phpunit-tests) Before you can run the PHPUnit tests you may need to run `composer install` to install all (development) dependencies. You can run all PHPUnit tests by running the following command (inside of the installed `php-imap` directory): `php vendor/bin/phpunit --testdox` ### Integration with frameworks [](#integration-with-frameworks) - Symfony - ### Getting Started Example [](#getting-started-example) Below, you'll find an example code how you can use this library. For further information and other examples, you may take a look at the [wiki](https://github.com/barbushin/php-imap/wiki). ``` // Create PhpImap\Mailbox instance for all further actions $mailbox = new PhpImap\Mailbox( '{imap.gmail.com:993/imap/ssl}INBOX', // IMAP server and mailbox folder 'some@gmail.com', // Username for the before configured mailbox '*********', // Password for the before configured username __DIR__, // Directory, where attachments will be saved (optional) 'UTF-8' // Server encoding (optional) ); try { // Get all emails (messages) // PHP.net imap_search criteria: http://php.net/manual/en/function.imap-search.php $mailsIds = $mailbox->searchMailbox('ALL'); } catch(PhpImap\Exceptions\ConnectionException $ex) { echo "IMAP connection failed: " . $ex; die(); } // If $mailsIds is empty, no emails could be found if(!$mailsIds) { die('Mailbox is empty'); } // Get the first message // If '__DIR__' was defined in the first line, it will automatically // save all attachments to the specified directory $mail = $mailbox->getMail($mailsIds[0]); // Show, if $mail has one or more attachments echo "\nMail has attachments? "; if($mail->hasAttachments()) { echo "Yes\n"; } else { echo "No\n"; } // Print all information of $mail print_r($mail); // Print all attachements of $mail echo "\n\nAttachments:\n"; print_r($mail->getAttachments()); ``` Method imap() allows to call any imap function in a context of the the instance: ``` // Call imap_check(); // http://php.net/manual/en/function.imap-check.php $info = $mailbox->imap('check'); // // Show current time for the mailbox $currentServerTime = isset($info->Date) && $info->Date ? date('Y-m-d H:i:s', strtotime($info->Date)) : 'Unknown'; echo $currentServerTime; ``` Some request require much time and resources: ``` // If you don't need to grab attachments you can significantly increase performance of your application $mailbox->setAttachmentsIgnore(true); // get the list of folders/mailboxes $folders = $mailbox->getMailboxes('*'); // loop through mailboxs foreach($folders as $folder) { // switch to particular mailbox $mailbox->switchMailbox($folder['fullpath']); // search in particular mailbox $mails_ids[$folder['fullpath']] = $mailbox->searchMailbox('SINCE "1 Jan 2018" BEFORE "28 Jan 2018"'); } print_r($mails_ids); ``` ### Recommended [](#recommended) - Google Chrome extension [PHP Console](https://chrome.google.com/webstore/detail/php-console/nfhmhhlpfleoednkpnnnkolmclajemef) - Google Chrome extension [JavaScript Errors Notifier](https://chrome.google.com/webstore/detail/javascript-errors-notifie/jafmfknfnkoekkdocjiaipcnmkklaajd) ### Health Score 34 — LowBetter than 77% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community19 Small or concentrated contributor base Maturity71 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~33 days Recently: every ~10 days Total 47 Last Release 2483d ago Major Versions 1.1 → 2.02015-04-20 2.2.5 → 3.0.02017-10-06 PHP version history (3 changes)1.0PHP >=5.3.0 3.0.0PHP >=5.5 3.0.9PHP >=5.6 ### Community Maintainers ![](https://www.gravatar.com/avatar/85d93938cbda24f3ae1b325d2c1ac89e95f1f845365395a693bad51e8b61b5d9?d=identicon)[BenPoulson](/maintainers/BenPoulson) --- Top Contributors [![barbushin](https://avatars.githubusercontent.com/u/683352?v=4)](https://github.com/barbushin "barbushin (146 commits)")[![Sebbo94BY](https://avatars.githubusercontent.com/u/5154682?v=4)](https://github.com/Sebbo94BY "Sebbo94BY (69 commits)")[![quentinus95](https://avatars.githubusercontent.com/u/8060564?v=4)](https://github.com/quentinus95 "quentinus95 (13 commits)")[![ThomasLandauer](https://avatars.githubusercontent.com/u/1054469?v=4)](https://github.com/ThomasLandauer "ThomasLandauer (9 commits)")[![SRWieZ](https://avatars.githubusercontent.com/u/1408020?v=4)](https://github.com/SRWieZ "SRWieZ (8 commits)")[![stanma](https://avatars.githubusercontent.com/u/1821782?v=4)](https://github.com/stanma "stanma (5 commits)")[![JellyBellyDev](https://avatars.githubusercontent.com/u/190820?v=4)](https://github.com/JellyBellyDev "JellyBellyDev (4 commits)")[![commanddotcom](https://avatars.githubusercontent.com/u/735385?v=4)](https://github.com/commanddotcom "commanddotcom (4 commits)")[![benpoulson](https://avatars.githubusercontent.com/u/1797843?v=4)](https://github.com/benpoulson "benpoulson (3 commits)")[![dizzy7](https://avatars.githubusercontent.com/u/1052472?v=4)](https://github.com/dizzy7 "dizzy7 (3 commits)")[![sharevb](https://avatars.githubusercontent.com/u/29117330?v=4)](https://github.com/sharevb "sharevb (3 commits)")[![nickl-](https://avatars.githubusercontent.com/u/1404606?v=4)](https://github.com/nickl- "nickl- (2 commits)")[![ebrana-devs](https://avatars.githubusercontent.com/u/7850167?v=4)](https://github.com/ebrana-devs "ebrana-devs (2 commits)")[![georaldc](https://avatars.githubusercontent.com/u/286812?v=4)](https://github.com/georaldc "georaldc (2 commits)")[![hyncica](https://avatars.githubusercontent.com/u/11272692?v=4)](https://github.com/hyncica "hyncica (2 commits)")[![Jekis](https://avatars.githubusercontent.com/u/1102024?v=4)](https://github.com/Jekis "Jekis (2 commits)")[![jlsalvador](https://avatars.githubusercontent.com/u/1464850?v=4)](https://github.com/jlsalvador "jlsalvador (2 commits)")[![pedrolopes10](https://avatars.githubusercontent.com/u/5683649?v=4)](https://github.com/pedrolopes10 "pedrolopes10 (2 commits)")[![stefangr](https://avatars.githubusercontent.com/u/957244?v=4)](https://github.com/stefangr "stefangr (2 commits)")[![Theaxiom](https://avatars.githubusercontent.com/u/57013?v=4)](https://github.com/Theaxiom "Theaxiom (2 commits)") --- Tags phpmailimappop3mailboxreceive emails ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/benpoulson-php-imap/health.svg) ``` [![Health](https://phpackages.com/badges/benpoulson-php-imap/health.svg)](https://phpackages.com/packages/benpoulson-php-imap) ``` ### Alternatives [php-imap/php-imap Manage mailboxes, filter/get/delete emails in PHP (supports IMAP/POP3/NNTP) 1.7k12.9M42](/packages/php-imap-php-imap)[webklex/php-imap PHP IMAP client 4365.5M14](/packages/webklex-php-imap)[benhall14/php-imap-reader A PHP class that makes working with IMAP in PHP simple. 3516.6k](/packages/benhall14-php-imap-reader)[henrique-borba/php-sieve-manager A modern (started in 2022) PHP library for the ManageSieve protocol (RFC5804) to create/edit Sieve scripts (RFC5228). Used by Cypht Webmail. 23125.7k2](/packages/henrique-borba-php-sieve-manager) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)