PHPackages                             vecode/moritabox-smtp - 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. [Utility & Helpers](/categories/utility)
4. /
5. vecode/moritabox-smtp

ActiveLibrary[Utility & Helpers](/categories/utility)

vecode/moritabox-smtp
=====================

MoritaBox SMTP Server

1.4.1(2y ago)125MITPHPPHP >=8.1

Since Aug 2Pushed 2y ago1 watchersCompare

[ Source](https://github.com/vecodenet/moritabox-smtp)[ Packagist](https://packagist.org/packages/vecode/moritabox-smtp)[ RSS](/packages/vecode-moritabox-smtp/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (1)Versions (7)Used By (0)

moritabox-smtp
==============

[](#moritabox-smtp)

Overview
--------

[](#overview)

SMTP server built with ReactPHP, supports PLAIN, LOGIN and CRAM-MD5 authentication.

An easy way to run a local SMTP server for testing mail implementations.

Requirements
------------

[](#requirements)

- `php`: `>=8.1`
- `react/socket`: `^1.13`

Installation
------------

[](#installation)

The easiest way to install it is to use Composer:

```
  composer require vecode/moritabox-smtp
```

Basic usage
-----------

[](#basic-usage)

Create an `SmtpServer` instance by passing an authentication callback; then subscribe to the `ready`, `mail` and/or `error` events:

```
use MoritaBox\Smtp\Mail;
use MoritaBox\Smtp\SmtpServer;
use MoritaBox\Smtp\SmtpHandler;

$server = new SmtpServer(function(string $user, SmtpHandler $handler) {
    return $user == 'user@example.com' ? 'secret' : false;
});

$server->on('ready', function(int $port) use ($output) {
    echo "Listening on port {$port}";
});

$server->on('mail', function(Mail $mail, SmtpHandler $handler) use ($output) {
    $filename = 'mail-'.microtime(true).'.eml';
    echo "Mail received, saving as '{$filename}'";
    file_put_contents(dirname(__FILE__) . DIRECTORY_SEPARATOR . $filename, $mail->getContents());
});

$server->on('error', function(Exception $e) use ($output) {
    $message = sprintf('%s @ %s:%d', $e->getMessage(), $e->getFile(), $e->getLine());
    echo $message;
});

$server->start();
```

The `ready` event is fired when the server is initialized and listening, the `error` event signals ReactPHP's `Socket` errors.

Finally, the `mail` event is fired when a complete mail message has been received, with a `Mail` instance which contains the from address, recipient addresses and all its contents in plain-text form so that you can store it or parse with a MIME message parser (for example by using the `mailparse` extension).

Note that you can change the listening port (defaults to `8025`) from the `SmtpServer` constructor and also you can specify the fully-qualified domain for the `CRAM-MD5` challenge and also set a flag so that the port is bound only locally (that is, allow connections from `127.0.0.1` only).

SSL/TLS is supported only in **implicit mode**, that is, the connection starts out with a secure handshake. For it to work you will need to enable it and pass the certificate and private key location (if required):

```
$server->start(true, [
    'local_cert' => '/home/contosso/certs/contosso-certificate.pem',
    'local_pk' => '/home/contosso/certs/contosso-key.pem',
]);
```

As you can see, the second parameter is an SSL context options listing [as defined here](https://www.php.net/manual/en/context.ssl.php).

STARTTLS is not supported due to a ReactPHP limitation.

### Authentication

[](#authentication)

Each of the supported authentication methods require you to provide an authentication callback that will receive the user name and must return the password for that user or `false` for non-existing users. As you can see, the returned password must be in plain-text, a limitation on the SMTP protocol, so it is advised to encrypt the passwords if you store them (in a database for example).

If you do not provide an authentication callback, it will be disabled, but it is generally not recommended unless you know what you are doing. For example, relay servers don't require authentication but they *must* validate the recipient address and reject the message if it is not valid.

### Validation

[](#validation)

You can also validate the sender/recipient (depending on the server's purpose) by means of the `setMailCallback` and `setRecipientCallback` methods, both of them take a `Closure` as argument that in turn receives an `$email` parameter; just return `true` to allow the address or `false` to deny it.

```
$server->setRecipientCallback(function(string $email, SmtpHandler $handler) {
    # Check for specific domain
    return str_ends_with($email, '@example.org');
});
```

This example uses a pretty simple approach, but you may use a regular expression or any other advanced mechanism to validate it should you like to.

### Using PHPMailer to send mail

[](#using-phpmailer-to-send-mail)

The most-common use case is testing email sent from other PHP projects, commonly implemented with PHPMailer or similar libraries.

In the following example you can see a basic setup; the most important bit is the authentication parameters (`SMTPAuth`, `Username` and `Password`, the later two will be checked via the authentication callback described in the previous section):

```
use PHPMailer\PHPMailer\PHPMailer;

$mail = new PHPMailer();

$mail->isSMTP();
$mail->Host = 'localhost';
$mail->Port = 8025;
$mail->SMTPAuth = true;
$mail->Username = 'user@example.com';
$mail->Password = 'secret';
$mail->SMTPDebug = true;
$mail->Timeout = 15;

$mail->setFrom('from@example.com', 'Mailer');
$mail->addAddress('joe@example.net', 'Joe User');
$mail->addAddress('ellen@example.com');
$mail->addReplyTo('info@example.com', 'Information');
$mail->addCC('cc@example.com');
$mail->addBCC('bcc@example.com');

$mail->Subject = 'Here is the subject';
$mail->Body    = 'This is the HTML message body in bold!';
$mail->AltBody = 'This is the body in plain text for non-HTML mail clients';

if(!$mail->send()) {
    echo 'Message could not be sent.';
    echo 'Mailer Error: ' . $mail->ErrorInfo;
} else {
    echo 'Message has been sent';
}
```

If you have enabled implicit SSL you must also set the `SMTPSecure` option as follows:

```
$mail->SMTPSecure = PHPMailer::ENCRYPTION_SMTPS;
```

License
-------

[](#license)

MIT licensed

Copyright © 2023 Vecode. All rights reserved.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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 ~55 days

Recently: every ~68 days

Total

6

Last Release

741d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/44b968bb45d47a621ce8e81c422ef4c126316a702156a7faf96df75610cc0d45?d=identicon)[biohzrdmx](/maintainers/biohzrdmx)

---

Top Contributors

[![biohzrdmx](https://avatars.githubusercontent.com/u/2053303?v=4)](https://github.com/biohzrdmx "biohzrdmx (17 commits)")

---

Tags

phpreactphpsmtp-server

### Embed Badge

![Health badge](/badges/vecode-moritabox-smtp/health.svg)

```
[![Health](https://phpackages.com/badges/vecode-moritabox-smtp/health.svg)](https://phpackages.com/packages/vecode-moritabox-smtp)
```

###  Alternatives

[friendsofphp/php-cs-fixer

A tool to automatically fix PHP code style

13.5k234.7M20.6k](/packages/friendsofphp-php-cs-fixer)[react/react

ReactPHP: Event-driven, non-blocking I/O with PHP.

9.1k3.6M63](/packages/react-react)[botman/botman

Create messaging bots in PHP with ease.

6.2k1.5M97](/packages/botman-botman)[wyrihaximus/react-child-process-messenger

Messenger decorator for react/child-process

32279.4k4](/packages/wyrihaximus-react-child-process-messenger)[rickysu/php-livereload

a livereload server implement by php

753.9k](/packages/rickysu-php-livereload)[xibosignage/xibo-xmr

Xibo Message Relay

1011.5k](/packages/xibosignage-xibo-xmr)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)