peehaa/mailgrab

Self contained mail catcher for debugging purposes

MailGrab

, _(*1)

Catch-all SMTP server for local debugging purposes., _(*2)

This SMTP server catches all e-mail being sent through it and provides an interface to inspect the e-mails., _(*3)

Note: this SMTP server is meant to be run locally. As such several security considerations (e.g. SMTP transaction delays) have been omitted by design. Never run this project as a public service., _(*4)

, _(*5)

Project status

This project is currently working towards a first stable release version.
The master branch of this project will always be in a functioning state and will always point to the last release., _(*6)

All active development should be based off the v0.4.0 branch., _(*7)

Current limitations

• Currently the project only supports unauthenticated smtp requests (without AUTH command)
• No persistent storage
• Because we currently only support in-memory storage the project may run out of memory when handling a lot of mails or mails with a lot attachments

Requirements

• PHP 7.1

Installation

Composer

composer create-project peehaa/mailgrab

Phar

Download the latest phar file from the releases page., _(*8)

Usage

Composer

./bin/mailgrab will start MailGrab using the default configuration:, _(*9)

• HTTP port: 9000
• SMTP port: 9025

See ./bin/mailgrab --help for more configuration options, _(*10)

Once the MailGrab server is started you can point your browser to http://localhost:9000 to access the webinterface.
If you send a mail to the server over port 9025 it will automatically be displayed in the webinterface.
There are example mail scripts available under ./examples (e.g. php examples/full-test.php) which you can run to test the functionality., _(*11)

Phar

/path/to/mailgrab.phar will start MailGrab using the default configuration:, _(*12)

• HTTP port: 9000
• SMTP port: 9025

See /path/to/mailgrab.phar --help for more configuration options, _(*13)

Build and development

NPM

To get started run npm install., _(*14)

An NPM build script is provided and can be used by running npm run build in the project root., _(*15)

Building phars

Currently all active development has to be based off the v0.4.0 branch., _(*16)

If you want to build a phar you can run the build script located at ./bin/build which will create a new build in the ./build directory., _(*17)