README.md in tuktuk-0.5.0 vs README.md in tuktuk-0.5.1

- old
+ new

@@ -7,10 +7,13 @@ This way you don't need to install Exim or Postfix and you can actually handle response status codes -- like bounces, 5xx -- within your application. Plus, it supports DKIM out of the box. +Delivering mail +--------------- + ``` ruby require 'tuktuk' message = { :from => 'you@username.com', @@ -34,12 +37,19 @@ else puts 'Email delivered!' end ``` -With Tuktuk, you can also deliver multiple messages at once. Depending on the max_workers config parameter, Tuktuk will either connect sequentially to the target MX servers, or do it in parallel by spawning threads. You need to pass an array of emails, and you'll receive an array of [response, email] elements, just as above. +Delivering multiple +------------------- +With Tuktuk, you can also deliver multiple messages at once. Depending on the `max_workers` config parameter, Tuktuk will either connect sequentially to the target domain's MX servers, or do it in parallel by spawning threads. + +Tuktuk will try to send all emails targeted for a specific domain on the same SMTP session. If a MX server is not responding -- or times out in the middle --, Tuktuk will try to deliver the remaining messages to next MX server, and so on. + +To #deliver_many, you need to pass an array of messages, and you'll receive an array of [response, email] elements, just as above. + ``` ruby messages = [ { ... }, { ... }, { ... }, { ... } ] # array of messages result = Tuktuk.deliver_many(messages) @@ -51,9 +61,12 @@ puts 'Email delivered!' end end ``` + +Options & DKIM +-------------- Now, if you want to enable DKIM (and you should): ``` ruby require 'tuktuk'