SMTP server (library) for receiving emails, written in pure PHP. This library provides an interface to the SMTP server-side protocol with PHP. It creates a \PhpMimeMailParser\Parser Class object for every incoming email and hands this object to a custom PHP function for further processing. The project is in Beta status, so it's not recommended for production use.
The d in SMTPd stands for Daemon. This script can run in background like any other daemon processes. It's not meant for running as a webapplication.
Believe it or not, email is still the killer feature of the Internet. There are tons of projects like PHPMailer: to send emails programmatically (with PHP). But there are not so many to receive emails from SMTP.
With this interface you can do something like this for your app users:
+------+ +------------------------+ +-------+ +--------------+
| User +---> | MUA (like Thunderbird) +---> | SMTPd +---> | Your PHP App |
+------+ +------------------------+ +-------+ +--------------+
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.
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/smtpd=~0.3"
At the moment the server accepts all incoming emails. You decide what happens with incoming emails by adding Events to the Server object ($server->eventAdd($event)). The server can handle certain events. Each event will be executed on a certain trigger. Even if you don't add any Events to the Server it accepts all incoming emails.
At the moment there are two Event Triggers.
TRIGGER_NEW_MAIL: will be triggered when a Client has finished transmitting a new email.TRIGGER_AUTH_ATTEMPT: will be triggered when a Client wants to authenticate. Return a boolean from the callback function whether the authentication was successful or not.
See also example.php file for full examples.
$server = new Server(...);
$event = new Event(Event::TRIGGER_NEW_MAIL, null, function(Event $event, $from, $rcpts, $mail){
// Do stuff: handle email, ...
});
$server->addEvent($event);
$server->loop();$server = new Server(...);
$event = new Event(Event::TRIGGER_AUTH_ATTEMPT, null, function(Event $event, $type, $credentials): bool{
// Do stuff: Check credentials against database, ...
return true;
});
$server->addEvent($event);
$server->loop();$server = new Server(...);
// Set up server here.
// Add Events, etc, ...
while(myApplicationRuns()){
// Do stuff your application needs.
// ...
// Run main SMTPd loop, once.
$server->run();
usleep(10000); // Never run a main thread loop without sleep. Never!
}- 3.5 OPENING AND CLOSING
- 3.1 MAIL
- 4.1.1 COMMAND SEMANTICS
- HELO
- RCPT
- DATA
- NOOP
- QUIT
- 4.1.1 First command
- 4.5 Error responses from extended servers
-
- The AUTH Command
You're welcome to contribute to this project. Fork this project at https://github.com/TheFox/smtpd. You should read GitHub's How to Fork a Repo.
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/.