PHPackages                             micc83/mailamie - 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. [Testing & Quality](/categories/testing)
4. /
5. micc83/mailamie

ActiveLibrary[Testing & Quality](/categories/testing)

micc83/mailamie
===============

Catch All SMTP Server for testing

1.1.0(4y ago)7753[4 issues](https://github.com/micc83/mailamie/issues)[7 PRs](https://github.com/micc83/mailamie/pulls)MITPHPPHP ^7.4|^8.0

Since Sep 28Pushed 3y ago1 watchersCompare

[ Source](https://github.com/micc83/mailamie)[ Packagist](https://packagist.org/packages/micc83/mailamie)[ Docs](https://github.com/micc83/mailamie)[ RSS](/packages/micc83-mailamie/feed)WikiDiscussions main Synced 6d ago

READMEChangelog (2)Dependencies (12)Versions (15)Used By (0)

[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)

Mailamie
========

[](#mailamie)

**Catch All SMTP Server for testing**

[![Tests](https://github.com/micc83/mailamie/workflows/Tests/badge.svg?branch=main)](https://github.com/micc83/mailamie/workflows/Tests/badge.svg?branch=main)[![PHP CS Fixer](https://github.com/micc83/mailamie/workflows/PHP%20CS%20Fixer/badge.svg?branch=main)](https://github.com/micc83/mailamie/workflows/PHP%20CS%20Fixer/badge.svg?branch=main)[![PHPStan](https://github.com/micc83/mailamie/workflows/PHPStan/badge.svg?branch=main)](https://github.com/micc83/mailamie/workflows/PHPStan/badge.svg?branch=main)[![codecov](https://camo.githubusercontent.com/a6753cb963db36135a6629f0917c16f7f0a36b9e3c6a037bdadd2c7bb7c821d4/68747470733a2f2f636f6465636f762e696f2f67682f6d69636338332f6d61696c616d69652f6272616e63682f6d61696e2f67726170682f62616467652e7376673f746f6b656e3d44536674727749626231)](https://codecov.io/gh/micc83/mailamie)

Index
-----

[](#index)

- [Why](#why)
- [About](#how)
- [Install](#install)
- [Usage](#usage)
- [Settings](#settings)
- [Changelog](changelog.md)
- [License](license.md)

Why
---

[](#why)

Sometime you just need a simple tool to verify that some legacy project, without tests in place or with some very complex environment, sends the right emails to the right people. Surely there're many valid tools out there for the job but as it's not something happening every day it's pretty cumbersome having to install these tools.

**Mailamie** is a side project I've put up in my summer vacations for playing with async PHP. Using it is as simple as setting a few parameters on your project:

```
# Ex. Laravel .env file
MAIL_MAILER=smtp
MAIL_HOST=127.0.0.1
MAIL_PORT=8025
MAIL_ENCRYPTION=null
```

and running it with the command:

```
$ mailamie
```

How
---

[](#how)

**Mailamie** is a pretty simple Catch All SMTP Server for local testing completely written in PHP and based on the great work made by the folks at [ReactPhp](https://reactphp.org/).

It's in no way a replacement for more complete tools such as [Mailhog](https://github.com/mailhog/MailHog) as it doesn't actually check SMTP implementantion details, instead it only cares about getting emails headers and body for high level delivery testing.

**DO NOT USE IN PRODUCTION**. Mailamie starts three different servers (SMTP on port 8025, HTTP on port 8080, WebSocket on port 1338). No steps have been taken to secure any of the three. Also, external access to those ports should be blocked.

**Mailamie** can be used directly from the CLI:

[![](docs/cli.png)](docs/cli.png)

or, for better UX, in the browser:

[![](docs/browser.png)](docs/browser.png)

Install
-------

[](#install)

**Mailamie** requires PHP ^7.4. To install it globally on your system run the following command to install:

```
composer global require micc83/mailamie
```

Usage
-----

[](#usage)

Run the following command to get help:

```
mailamie --help
```

The output will be:

```
Description:
  Mailamie is catch all SMTP server for testing.

Usage:
  mailamie [options]
  mailamie --host=127.0.0.1 --port=25    Ex. SMTP Host definition

Options:
  -H, --host=HOST       Set the host on which to listen for calls
  -p, --port=PORT       Set the port on which to listen for SMTP calls
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  You can define custom configuration from the file ~/.mailamie.config.php,
  check the project readme file at https://github.com/micc83/mailamie
  for all the available settings.
```

Settings
--------

[](#settings)

You can define default settings in `~/.mailamie.config.php`, in order to do so run:

```
$ touch ~/.mailamie.config.php && vim ~/.mailamie.config.php
```

This files returns a PHP array with the following available settings.

```