Skip to content

Commit

Permalink
doc: Update documentation and minor text erratas - no functional or c…
Browse files Browse the repository at this point in the history
…ode changes
  • Loading branch information
TomFreudenberg committed Sep 12, 2015
1 parent 6a98029 commit d955cbb
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 13 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ MidiSmtpServer can be easy customized via subclassing. Simply subclass the `Midi
def on_disconnect_event(ctx)
end

# get event on HELO:
# get event on HELO/EHLO:
def on_helo_event(ctx, helo_data)
end

Expand Down Expand Up @@ -299,14 +299,14 @@ You can access some important client and server values by using the `ctx` array
ctx[:server][:remote_host]
ctx[:server][:remote_port]

# connection timestampe
# connection timestamp (utc)
ctx[:server][:connected]

# authentification infos
ctx[:server][:authorization_id]
ctx[:server][:authentication_id]

# successful authentication timestamp
# successful authentication timestamp (utc)
ctx[:server][:authenticated]

# envelope mail from
Expand All @@ -315,9 +315,11 @@ You can access some important client and server values by using the `ctx` array
# envelope rcpt_to array
ctx[:envelope][:to][0]

# access message in on_message_data_event
# timestamp (utc) when message data was completly received
ctx[:message][:delivered]
ctx[:message][:bytesite]

# access message in on_message_data_event
ctx[:message][:bytesize]
ctx[:message][:data]

```
Expand All @@ -343,19 +345,25 @@ We created a SMTP-Server e.g. to receive messages vie SMTP and store them to Rab
You will find a detailed description of class methods and parameters at [RubyDoc](http://www.rubydoc.info/gems/midi-smtp-server/MidiSmtpServer/Smtpd)


## New to version 2.x
## New to version 2.1.1

1. Huge speed improvement on receiving large message data (1.000+ faster)

1. Modulelized
2. Removed dependency to GServer
3. Additional events to interact with
4. Use logger to log several messages from severity :debug up to :fatal

## New to version 2.1

1. Authentication PLAIN, LOGIN
2. Safe `join` will catch and rescue `Interrupt`


## New to version 2.x

1. Modulelized
2. Removed dependency to GServer
3. Additional events to interact with
4. Use logger to log several messages from severity :debug up to :fatal


## From version 1.x to 2.x

If you are already using MidiSmtpServer at a release 1.x it might be only some straight forward work to get your code work with version 2.x.
Expand Down
2 changes: 1 addition & 1 deletion lib/midi-smtp-server.rb
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ def on_disconnect_event(ctx)
logger.debug("Client disconnect from #{ctx[:server][:remote_ip]}:#{ctx[:server][:remote_port]}")
end

# get event on HELO:
# get event on HELO/EHLO:
def on_helo_event(ctx, helo_data)
end

Expand Down
4 changes: 2 additions & 2 deletions midi-smtp-server.gemspec
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Gem::Specification.new do |s|
s.name = 'midi-smtp-server'
s.version = '2.1.1'
s.date = '2015-09-11'
s.version = '2.1.2'
s.date = '2015-09-12'
s.summary = "MidiSmtpServer Class"
s.description = "A small and highly customizable ruby SMTP-Server."
s.authors = ["Tom Freudenberg"]
Expand Down

0 comments on commit d955cbb

Please sign in to comment.