2
2
3
3
[ ![ Latest Stable Version] ( https://poser.pugx.org/peehaa/mailgrab/v/stable )] ( https://packagist.org/packages/peehaa/mailgrab )
4
4
[ ![ Build Status] ( https://travis-ci.org/PeeHaa/mailgrab.svg?branch=master )] ( https://travis-ci.org/PeeHaa/mailgrab )
5
- [ ![ Coverage Status] ( https://coveralls.io/repos/github/PeeHaa/mailgrab/badge.svg?branch=master )] ( https://coveralls.io/github/PeeHaa/mailgrab?branch=master )
6
5
[ ![ Build status] ( https://ci.appveyor.com/api/projects/status/0vg23vb7ohyuxjqr/branch/master?svg=true )] ( https://ci.appveyor.com/project/PeeHaa/mailgrab/branch/master )
6
+ [ ![ Coverage Status] ( https://coveralls.io/repos/github/PeeHaa/mailgrab/badge.svg?branch=master )] ( https://coveralls.io/github/PeeHaa/mailgrab?branch=master )
7
7
[ ![ License] ( https://poser.pugx.org/peehaa/mailgrab/license )] ( https://packagist.org/packages/peehaa/mailgrab )
8
8
9
9
Catch-all SMTP server for local debugging purposes.
@@ -19,12 +19,11 @@ This SMTP server catches all e-mail being sent through it and provides an interf
19
19
This project is currently working towards a first stable release version.
20
20
The master branch of this project will always be in a functioning state and will always point to the last release.
21
21
22
- All active development should be based off the v0.3 .0 branch.
22
+ All active development should be based off the v0.4 .0 branch.
23
23
24
24
### Current limitations
25
25
26
- - Currently the project only supports unauthenticated smtp requests (without ` AUTH ` command).
27
- - Attachments are not supported as downloads
26
+ - Currently the project only supports unauthenticated smtp requests (without ` AUTH ` command)
28
27
- No persistent storage
29
28
- 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
30
29
@@ -40,7 +39,7 @@ All active development should be based off the v0.3.0 branch.
40
39
41
40
### Phar
42
41
43
- Download the latest phar file from the [ releases] ( https://github.com/PeeHaa/mailgrab/releases ) page and make the file executable .
42
+ Download the latest phar file from the [ releases] ( https://github.com/PeeHaa/mailgrab/releases ) page.
44
43
45
44
## Usage
46
45
@@ -53,6 +52,10 @@ Download the latest phar file from the [releases](https://github.com/PeeHaa/mail
53
52
54
53
* See ` ./bin/mailgrab --help ` for more configuration options*
55
54
55
+ Once the MailGrab server is started you can point your browser to ` http://localhost:9000 ` to access the webinterface.
56
+ If you send a mail to the server over port 9025 it will automatically be displayed in the webinterface.
57
+ There are example mail scripts available under ` ./examples ` (e.g. ` php examples/full-test.php ` ) which you can run to test the functionality.
58
+
56
59
### Phar
57
60
58
61
` /path/to/mailgrab.phar ` will start MailGrab using the default configuration:
@@ -62,10 +65,6 @@ Download the latest phar file from the [releases](https://github.com/PeeHaa/mail
62
65
63
66
* See ` /path/to/mailgrab.phar --help ` for more configuration options*
64
67
65
- Once the MailGrab server is started you can point your browser to ` http://localhost:9000 ` to access the webinterface.
66
- If you send a mail to the server over port 9025 it will automatically be displayed in the webinterface.
67
- There are example mail scripts available under ` ./examples ` (e.g. ` php examples/full-test.php ` ) which you can run to test the functionality.
68
-
69
68
## Build and development
70
69
71
70
### NPM
@@ -76,6 +75,6 @@ An NPM build script is provided and can be used by running `npm run build` in th
76
75
77
76
### Building phars
78
77
79
- Currently all active development has to be based off the v0.3 .0 branch.
78
+ Currently all active development has to be based off the v0.4 .0 branch.
80
79
81
80
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.
0 commit comments