Skip to content

Commit

Permalink
Update READ.ME and GettingStarted
Browse files Browse the repository at this point in the history
  • Loading branch information
bigjosh committed Feb 5, 2016
1 parent 8dc9ab8 commit af9eec6
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 120 deletions.
22 changes: 22 additions & 0 deletions GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Run a demo SubethaSMTP Server #

1. Download the most recent `subethasmtp.jar` file from the releases section on Github
2. Run the command `java -cp subetha.jar org.sebethamail.examples.BasicSMTPServer`
3. Use `TELNET` or an SMTP client to connect to the now-running server on TCP port 25000.


# Enable logging #

Note that SubethaSMTP uses the SLF4J logging framework. When the program starts up, it will look for a compatible logging connector in the classpath. If none is found it will print a warning message to the console and then silently toss any log messages generated by the program.

If you want to see the logging messages, you need a compatible connector in the classpath.

You can download connectors from the [SLF4J website](http://www.slf4j.org/download.html). The `Simple` connector is very simple and just prints log messages to stderr. Note that the version of the connector must match the version that SubethaSMTP was built against.


# Editing in Eclipse

1. Clone the repository from GitHub to your local machine.
2. Open Eclipse and do `Import->Maven->Existing Maven Projects`
3. Right click on the `POM.XML` file and select `Run As->Maven Install`

13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,22 @@ During the development of SubEtha's testing harness, we tried out the [Dumbster]

We hate reinventing wheels. This should be the LAST FREAKING JAVA SMTP IMPLEMENTATION.

## A New Fork ##
This new fork by Engine821.com intends to tidy up some of the structure, while keeping the original (and excellent!) design and code. We are using this as a base for a production product, so intend on keeping the code fresh and well maintained.

We too did a survey of existing Java SMTP implementations and were unsatisfied... until we found SubEthaSMTP! The code is clean and very well thought out. So far the changes we've made are minor, including...

* Eliminating the embedded `/lib` directory. Maven correctly handles pulling in all the dependencies and best practices discourage keeping binary artifacts inside version control.
* Updating to the latest versions of some of the libraries used.
* Removing some of the IDE metadata files. Your IDE can rercreate whichever ones you need based on your preferences and the Maven POM.
* Making the message handing exceptions be `checked`. This is possibly controversial, but we thought about it a lot and prefer to have these exceptions show up in the `throws` clause rather than have them potentially pop-up unexpectedly at run-time.


## Project Authors ##
Ian McFarland contributed the first codebase to SubEtha Mail. Then, Jon Stevens and Jeff Schnitzer re-wrote most of Ian's code into what we have today. Edouard De Oliveira and Scott Hernandez have also made significant contributions.

## Support ##
If you have any bug reports, questions or comments about SubEtha SMTP, it's best that you bring these issues up on the Mailing Lists. Please do not email the authors directly.
If you have any bug reports, questions or comments about this SubEtha SMTP fork, it's best that you use the GitHub issue tracker to get in touch. Please do not email the authors directly.

## Spec Compliance ##
For now, we have just focused on implementing just the minimal required aspects of http://rfc.net/rfc2821.html#s4.5.1. We also return SMTP status responses that mimic what Postfix returns.
Expand Down
119 changes: 0 additions & 119 deletions SimpleExample.md

This file was deleted.

0 comments on commit af9eec6

Please sign in to comment.