Skip to content
This repository has been archived by the owner on May 30, 2021. It is now read-only.

Commit

Permalink
Updated Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
aarongough committed Nov 5, 2010
1 parent 8eac869 commit 062b0e3
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.rdoc
@@ -1,26 +1,20 @@
= mini-smtp-server = mini-smtp-server


MiniSmtpServer is a small and easily customizable SMTP server. It is designed mainly to be integrated into other systems that will decide what to do with the mail that is received. By default mini-smtp-server operates as a black-hole and does not do anything with the mail being sent to it... Don't let that discourage you though, as the system is designed to be extremely easy to customize which makes it fit more easily into your system! MiniSmtpServer is a small and easily customizable SMTP server. It is designed mainly to be integrated into other systems that will decide what to do with the mail that is received. By default mini-smtp-server operates as a black-hole and does not do anything with the mail being sent to it... Don't let that discourage you though, as MiniSmtpServer is designed to be extremely easy to customize which makes it fit more easily into your system!

=== Installation

MiniSmtpServer is packaged as a RubyGem, so installing it is as easy as:

gem install mini-smtp-server


=== Using the server === Using the server


To run the default server simply use: To run the default server simply use:


# Create a new server instance listening at 127.0.0.1:2525 # Create a new server instance listening at 127.0.0.1:2525
# and accepting a maximum of 4 simultaneous connections # and accepting a maximum of 4 simultaneous connections
server = MiniSmtpServer.new(port_number = 2525, host = "127.0.0.1", max_connections = 4) server = MiniSmtpServer.new(2525, "127.0.0.1", 4)


# Start the server # Start the server
server.start server.start


# ... # ...
# serving requests # serving requests & doing other work here
# ... # ...


# Shutdown the server without interrupting any connections: # Shutdown the server without interrupting any connections:
Expand All @@ -30,6 +24,12 @@ To run the default server simply use:
end end
server.stop server.stop
server.join server.join

=== Installation

For convenience MiniSmtpServer is packaged as a RubyGem, to install it simply enter the following at your command line:

gem install mini-smtp-server


=== Customizing the server === Customizing the server


Expand Down Expand Up @@ -73,6 +73,6 @@ If you have a great example of something you've done with MiniSmtpServer let me


Author:: {Aaron Gough}[mailto:aaron@aarongough.com] Author:: {Aaron Gough}[mailto:aaron@aarongough.com]


MiniSmtpServer was inspired by code written by {Peter Cooper}[http://peterc.org/] MiniSmtpServer is based on code originally written by {Peter Cooper}[http://peterc.org/]


Copyright (c) 2010 {Aaron Gough}[http://thingsaaronmade.com/] ({thingsaaronmade.com}[http://thingsaaronmade.com/]), released under the MIT license Copyright (c) 2010 {Aaron Gough}[http://thingsaaronmade.com/] ({thingsaaronmade.com}[http://thingsaaronmade.com/]), released under the MIT license

0 comments on commit 062b0e3

Please sign in to comment.