Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micc83/mailamie
🌈 Mailamie is a simple SMTP catch all server for testing written in PHP.
https://github.com/micc83/mailamie
php smtp-server testing
Last synced: about 1 month ago
JSON representation
🌈 Mailamie is a simple SMTP catch all server for testing written in PHP.
- Host: GitHub
- URL: https://github.com/micc83/mailamie
- Owner: micc83
- License: mit
- Created: 2020-08-15T21:33:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T21:55:53.000Z (almost 2 years ago)
- Last Synced: 2024-09-18T13:11:22.953Z (4 months ago)
- Topics: php, smtp-server, testing
- Language: PHP
- Homepage:
- Size: 1.49 MB
- Stars: 77
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license.md
Awesome Lists containing this project
README
[](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
# Mailamie
**Catch All SMTP Server for testing**
[](https://codecov.io/gh/micc83/mailamie)
## Index
- [Why](#why)
- [About](#how)
- [Install](#install)
- [Usage](#usage)
- [Settings](#settings)
- [Changelog](changelog.md)
- [License](license.md)
## 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:
```dotenv
# 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:
```shell script
$ mailamie
```
## 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:
or, for better UX, in the browser:
## Install
**Mailamie** requires PHP ^7.4. To install it globally on your system run the following command to install:
```shell script
composer global require micc83/mailamie
```
## Usage
Run the following command to get help:
```shell script
mailamie --help
```
The output will be:
```shell script
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
You can define default settings in `~/.mailamie.config.php`, in order to do so run:
```shell script
$ touch ~/.mailamie.config.php && vim ~/.mailamie.config.php
```
This files returns a PHP array with the following available settings.
```php
[
'host' => '127.0.0.1',
'port' => '8025'
],
'http' => [
'host' => '127.0.0.1',
'port' => '8080'
],
'websocket' => [
'host' => '127.0.0.1',
'port' => '1338'
],
];
```
You'd better define only the needed ones, in case something should change after upgrades.