IMAP server (library) to serve emails to an email client, written in pure PHP.
PHP Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
src/TheFox/Imap
tests/TheFox/Test
.ackrc
.dockerignore
.editorconfig
.env.example
.gitignore
.travis.yml
Dockerfile
README.md
composer.json
example.php
imapd.sublime-project
phpcs.xml
phpunit.xml

README.md

IMAPd

IMAP server (library) to serve emails to an email client, written in pure PHP.

The d in SMTPd stands for Daemon. This script can run in background like any other daemon process. It's not meant for running as a webapplication.

Why this project?

Believe it or not, email is still the killer feature of the Internet. There are tons of projects for accessing and fetching emails from an IMAP/POP3 server. But there are not so many providing a programmatically interface to serve emails to an email client.

With this interface you can do something like this for your app users:

+--------------+     +-------+     +------------------------+     +------+
| Your PHP App +---> | IMAPd +---> | MUA (like Thunderbird) +---> | User |
+--------------+     +-------+     +------------------------+     +------+

This is useful when you have a messaging application written in PHP but no graphical user interface for it. So your graphical user interface can be any email client. Thunderbird for instance.

Installation

The preferred method of installation is via Packagist and Composer. Run the following command to install the package and add it as a requirement to composer.json:

composer.phar require thefox/imapd

Usage

See example.php file for more information.

RFC 3501 Implementation

Complete implementation

  • 6.1.2 NOOP Command
  • 6.1.3 LOGOUT Command
  • 6.4.1 CHECK Command
  • 6.4.7 COPY Command
  • 7.1.1 OK Response
  • 7.1.2 NO Response
  • 7.1.3 BAD Response
  • 7.1.5 BYE Response
  • 7.4.1 EXPUNGE Response

Incomplete implemention

  • 2.3.1.1 Unique Identifier (UID) Message Attribute
  • 2.3.1.2 Message Sequence Number Message Attribute
  • 2.3.2 Flags Message Attribute
  • 6.1.1 CAPABILITY Command
  • 6.2.2 AUTHENTICATE Command
  • 6.2.3 LOGIN Command
  • 6.3.1 SELECT Command
  • 6.3.6 SUBSCRIBE Command
  • 6.3.7 UNSUBSCRIBE Command
  • 6.3.8 LIST Command
  • 6.3.9 LSUB Command
  • 6.3.11 APPEND Command
  • 6.4.2 CLOSE Command
  • 6.4.4 SEARCH Command
  • 6.4.5 FETCH Command
  • 6.4.6 STORE Command
  • 6.4.8 UID Command
  • 7.1.4 PREAUTH Response
  • 7.2.1 CAPABILITY Response
  • 7.2.2 LIST Response
  • 7.2.3 LSUB Response
  • 7.2.5 SEARCH Response
  • 7.3.1 EXISTS Response
  • 7.3.2 RECENT Response
  • 7.4.2 FETCH Response

TODO

  • Some tasks are commented with NOT_IMPLEMENTED. Implement these.
  • @TODO are to be complete the PHP Code Sniffer tests before releasing a new version.

Alternatives for Zend\Mail

Related Links

Related Projects

Contribute

You're welcome to contribute to this project. Fork this project at https://github.com/TheFox/imapd. You should read GitHub's How to Fork a Repo.

Project Links

License

Copyright (C) 2014 Christian Mayer https://fox21.at

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.