Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PeeHaa/mailgrab
Simple and easy to use catch-all SMTP mail server and debugging tool
https://github.com/PeeHaa/mailgrab
amphp async debugging mail mailcatcher smtp smtp-server
Last synced: 3 months ago
JSON representation
Simple and easy to use catch-all SMTP mail server and debugging tool
- Host: GitHub
- URL: https://github.com/PeeHaa/mailgrab
- Owner: PeeHaa
- License: mit
- Created: 2018-02-21T13:44:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-31T16:41:56.000Z (over 4 years ago)
- Last Synced: 2024-01-18T08:21:32.196Z (6 months ago)
- Topics: amphp, async, debugging, mail, mailcatcher, smtp, smtp-server
- Language: JavaScript
- Homepage:
- Size: 1.07 MB
- Stars: 92
- Watchers: 8
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - mailgrab - all SMTP mail server and debugging tool | PeeHaa | 86 | (JavaScript)
- awesome-stars - mailgrab - Simple and easy to use catch-all SMTP mail server and debugging tool (JavaScript)
README
# MailGrab
[](https://packagist.org/packages/peehaa/mailgrab)
[](https://travis-ci.org/PeeHaa/mailgrab)
[](https://ci.appveyor.com/project/PeeHaa/mailgrab/branch/master)
[](https://coveralls.io/github/PeeHaa/mailgrab?branch=master)
[](https://packagist.org/packages/peehaa/mailgrab)
Catch-all SMTP server for local debugging purposes.
This SMTP server catches all e-mail being sent through it and provides an interface to inspect the e-mails.
*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.*
## 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.
All active development should be based off the v0.4.0 branch.
### 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](https://github.com/PeeHaa/mailgrab/releases) page.
## Usage
### Composer
`./bin/mailgrab` will start MailGrab using the default configuration:
- HTTP port: 9000
- SMTP port: 9025
*See `./bin/mailgrab --help` for more configuration options*
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.
### Phar
`/path/to/mailgrab.phar` will start MailGrab using the default configuration:
- HTTP port: 9000
- SMTP port: 9025
*See `/path/to/mailgrab.phar --help` for more configuration options*
## Build and development
### NPM
To get started run `npm install`.
An NPM build script is provided and can be used by running `npm run build` in the project root.
### Building phars
Currently all active development has to be based off the v0.4.0 branch.
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.