Skip to content

Commit

Permalink
Preparation for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
PeeHaa committed Apr 25, 2018
1 parent b4558a4 commit 009e3c5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[![Latest Stable Version](https://poser.pugx.org/peehaa/mailgrab/v/stable)](https://packagist.org/packages/peehaa/mailgrab)
[![Build Status](https://travis-ci.org/PeeHaa/mailgrab.svg?branch=master)](https://travis-ci.org/PeeHaa/mailgrab)
[![Coverage Status](https://coveralls.io/repos/github/PeeHaa/mailgrab/badge.svg?branch=master)](https://coveralls.io/github/PeeHaa/mailgrab?branch=master)
[![Build status](https://ci.appveyor.com/api/projects/status/0vg23vb7ohyuxjqr/branch/master?svg=true)](https://ci.appveyor.com/project/PeeHaa/mailgrab/branch/master)
[![Coverage Status](https://coveralls.io/repos/github/PeeHaa/mailgrab/badge.svg?branch=master)](https://coveralls.io/github/PeeHaa/mailgrab?branch=master)
[![License](https://poser.pugx.org/peehaa/mailgrab/license)](https://packagist.org/packages/peehaa/mailgrab)

Catch-all SMTP server for local debugging purposes.
Expand All @@ -19,12 +19,11 @@ This SMTP server catches all e-mail being sent through it and provides an interf
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.3.0 branch.
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).
- Attachments are not supported as downloads
- 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

Expand All @@ -40,7 +39,7 @@ All active development should be based off the v0.3.0 branch.

### Phar

Download the latest phar file from the [releases](https://github.com/PeeHaa/mailgrab/releases) page and make the file executable.
Download the latest phar file from the [releases](https://github.com/PeeHaa/mailgrab/releases) page.

## Usage

Expand All @@ -53,6 +52,10 @@ Download the latest phar file from the [releases](https://github.com/PeeHaa/mail

*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:
Expand All @@ -62,10 +65,6 @@ Download the latest phar file from the [releases](https://github.com/PeeHaa/mail

*See `/path/to/mailgrab.phar --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.

## Build and development

### NPM
Expand All @@ -76,6 +75,6 @@ An NPM build script is provided and can be used by running `npm run build` in th

### Building phars

Currently all active development has to be based off the v0.3.0 branch.
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.
2 changes: 1 addition & 1 deletion public/js/bundle.js.map

Large diffs are not rendered by default.

0 comments on commit 009e3c5

Please sign in to comment.