Update validates_email_format_of plugin
[rails.git] / vendor / plugins / validates_email_format_of / README.rdoc
1 = validates_email_format_of Gem and Rails Plugin
2
3 Validate e-mail addresses against RFC 2822 and RFC 3696.
4
5 == Installation
6
7 Installing as a gem:
8
9   gem sources -a http://gems.github.com
10   gem install alexdunae-validates_email_format_of
11
12 Installing as a Ruby on Rails plugin:
13
14   ./script/plugin install http://github.com/alexdunae/validates_email_format_of.git
15
16
17 == Usage
18
19  class Person < ActiveRecord::Base
20    validates_email_format_of :email
21  end
22
23 As of version 1.4, it's possible to run e-mail validation tests (including MX 
24 checks) without using ActiveRecord or even touching a database.  The 
25 <tt>validate_email_format</tt> method will return <tt>nil</tt> on a valid 
26 e-mail address or an array of error messages for invalid addresses.
27
28   results = ValidatesEmailFormatOf::validate_email_format(email, options)
29
30   if results.nil?
31     # success!
32   else
33     puts results.join(', ')
34   end
35
36
37 === Options
38
39   :message
40      String. A custom error message (default is: " does not appear to be a valid e-mail address")
41   :on
42      Symbol. Specifies when this validation is active (default is :save, other options :create, :update)
43   :allow_nil
44      Boolean. Allow nil values (default is false)
45   :allow_blank
46      Boolean. Allow blank values (default is false)
47   :check_mx
48      Boolean. Check domain for a valid MX record (default is false)
49   :if
50      Specifies a method, proc or string to call to determine if the validation should occur 
51      (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The method, 
52      proc or string should return or evaluate to a true or false value. 
53   :unless
54      See :if option.
55
56 == Testing
57
58 To execute the unit tests run <tt>rake test</tt>.
59
60 The unit tests for this plugin use an in-memory sqlite3 database.
61
62 == Resources
63
64 * http://github.com/alexdunae/validates_email_format_of
65 * http://code.dunae.ca/validates_email_format_of.html
66
67 == Credits
68
69 Written by Alex Dunae (dunae.ca), 2006-09.
70
71 Thanks to Francis Hwang (http://fhwang.net/) at Diversion Media for creating the 1.1 update.
72
73 Thanks to Travis Sinnott for creating the 1.3 update.
74
75 Thanks to Denis Ahearn at Riverock Technologies (http://www.riverocktech.com/) for creating the 1.4 update.
76
77 Thanks to George Anderson (http://github.com/george) and 'history' (http://github.com/history) for creating the 1.4.1 update.