alexdunae-validates_email_format_of

= validates_email_format_of Gem and Rails Plugin

Validate e-mail addresses against RFC 2822 and RFC 3696.

== Installation

Installing as a gem:

gem sources -a http://gems.github.com gem install alexdunae-validates_email_format_of

Installing as a Ruby on Rails plugin:

./script/plugin install git://github.com/alexdunae/validates_email_format_of.git

== Usage

class Person < ActiveRecord::Base validates_email_format_of :email end

=== Options

:message String. A custom error message (default is: " does not appear to be a valid e-mail address") :on Symbol. Specifies when this validation is active (default is :save, other options :create, :update) :allow_nil Boolean. Allow nil values (default is false) :allow_blank Boolean. Allow blank values (default is false) :check_mx Boolean. Check domain for a valid MX record (default is false) :if Specifies a method, proc or string to call to determine if the validation should occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The method, proc or string should return or evaluate to a true or false value. :unless See :if option.

== Testing

To execute the unit tests run rake test.

The unit tests for this plugin use an in-memory sqlite3 database.

== Resources

• http://github.com/alexdunae/validates_email_format_of
• http://code.dunae.ca/validates_email_format_of.html

== Credits

Written by Alex Dunae (dunae.ca), 2006-09.

Thanks to Francis Hwang (http://fhwang.net/) at Diversion Media for creating the 1.1 update.

Thanks to Travis Sinnott for creating the 1.3 update.