public
Description: The official fork is now maintained by benprew in http://github.com/benprew/pony
Homepage: http://github.com/benprew/pony
Clone URL: git://github.com/adamwiggins/pony.git
adamwiggins (author)
Wed Sep 23 19:38:54 -0700 2009
commit  d4a3d4cfac522a204b6e44dbf5198027c71809bb
tree    a5d3a4ffd8afe7cf3d5f12aed7bd3a99bd7f2807
parent  346b9018a60140fbbbbfcae9be7cff81e3e491d7
pony / README.rdoc
100644 43 lines (25 sloc) 1.305 kb

Pony, the express way to send email in Ruby

Overview

Ruby no longer has to be jealous of PHP’s mail() function, which can send an email in a single command.

  Pony.mail(:to => 'you@example.com', :from => 'me@example.com', :subject => 'hi', :body => 'Hello there.')

Any option key may be omitted except for :to.

Transport

Pony uses /usr/sbin/sendmail to send mail if it is available, otherwise it uses SMTP to localhost.

This can be over-ridden if you specify a via option

  Pony.mail(:to => 'you@example.com', :via => :smtp) # sends via SMTP

  Pony.mail(:to => 'you@example.com', :via => :sendmail) # sends via sendmail

You can also specify options for SMTP:

  Pony.mail(:to => 'you@example.com', :via => :smtp, :smtp => {
    :host     => 'smtp.yourserver.com',
    :port     => '25',
    :user     => 'user',
    :password => 'pass',
    :auth     => :plain,           # :plain, :login, :cram_md5, no auth by default
    :domain   => "example.com"     # the HELO domain provided by the client to the server
  }

Meta

Written by Adam Wiggins

Patches contributed by: Mathieu Martin, Arun Thampi, Thomas Hurst, Stephen Celis, Othmane Benkirane, and Neil Mock

Released under the MIT License: www.opensource.org/licenses/mit-license.php

github.com/adamwiggins/pony