Update validates_email_format_of plugin

[rails.git] / vendor / plugins / validates_email_format_of / README.rdoc

diff --git a/vendor/plugins/validates_email_format_of/README.rdoc b/vendor/plugins/validates_email_format_of/README.rdoc
new file mode 100644 (file)
index 0000000..fd1fa8c
--- /dev/null
+++ b/vendor/plugins/validates_email_format_of/README.rdoc
@@ -0,0 +1,77 @@
+= 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 http://github.com/alexdunae/validates_email_format_of.git
+
+
+== Usage
+
+ class Person < ActiveRecord::Base
+   validates_email_format_of :email
+ end
+
+As of version 1.4, it's possible to run e-mail validation tests (including MX 
+checks) without using ActiveRecord or even touching a database.  The 
+<tt>validate_email_format</tt> method will return <tt>nil</tt> on a valid 
+e-mail address or an array of error messages for invalid addresses.
+
+  results = ValidatesEmailFormatOf::validate_email_format(email, options)
+
+  if results.nil?
+    # success!
+  else
+    puts results.join(', ')
+  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 <tt>rake test</tt>.
+
+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.
+
+Thanks to Denis Ahearn at Riverock Technologies (http://www.riverocktech.com/) for creating the 1.4 update.
+
+Thanks to George Anderson (http://github.com/george) and 'history' (http://github.com/history) for creating the 1.4.1 update.
\ No newline at end of file