Module: ValidatesAsEmailAddress

Defined in:
lib/validates_as_email_address.rb,
lib/validates_as_email_address/rfc_822.rb,
lib/validates_as_email_address/rfc_1035.rb

Overview

Adds validations for email addresses

Defined Under Namespace

Modules: RFC1035, RFC822

Instance Method Summary collapse

Instance Method Details

#validates_as_email_address(*attr_names) ⇒ Object

Validates whether the value of the specific attribute matches against the RFC822/RFC1035 specification.

class Person < ActiveRecord::Base
  validates_as_email_address :email, :on => :create
end

This will also validate that the email address is within the specification limits, i.e. between 3 and 320 characters in length.

Configuration options for length:

  • :minimum - The minimum size of the attribute

  • :maximum - The maximum size of the attribute

  • :is - The exact size of the attribute

  • :within - A range specifying the minimum and maximum size of the attribute

  • :in - A synonym (or alias) for :within

  • :too_long - The error message if the attribute goes over the maximum (default is: “is too long (maximum is %d characters)”)

  • :too_short - The error message if the attribute goes under the minimum (default is: “is too short (minimum is %d characters)”)

  • :wrong_length - The error message if using the :is method and the attribute is the wrong size (default is: “is the wrong length (should be %d characters)”)

  • :tokenizer - Specifies how to split up the attribute string. (e.g. :tokenizer => lambda {|str| str.scan(/\w+/)} to count words.) Defaults to lambda {|value| value.split(//)} which counts individual characters.

Configuration options for format:

  • :wrong_format - A custom error message (default is: “is an invalid email address”)

Miscellaneous configuration options:

  • :allow_nil - Attribute may be nil; skip validation.

  • :allow_blank - Attribute may be blank; skip validation.

  • :on - Specifies when this validation is active (default is :save, other options :create, :update)

  • :if - Specifies a method, proc or string to call to determine if the validation should occur (e.g. :if => :allow_validation, or :if => lambda { |user| user.signup_step > 2 }). The method, proc or string should return or evaluate to a true or false value.

  • :strict - Specifies if the domain part of the email should be compliant to RFC 1035 (default is true). If set to false domains such as ‘-online.com’, ‘[127.0.0.1]’ become valid.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/validates_as_email_address.rb', line 55

def validates_as_email_address(*attr_names)
  configuration = attr_names.last.is_a?(Hash) ? attr_names.pop : {}
  configuration.reverse_merge!(
    :wrong_format => Object.const_defined?(:I18n) ? :invalid_email : ActiveRecord::Errors.default_error_messages[:invalid_email],
    :strict => true
  )
  
  # Add format validation
  format_configuration = configuration.dup
  format_configuration[:message] = configuration.delete(:wrong_format)
  format_configuration[:with] = configuration[:strict] ? RFC1035::EmailAddress : RFC822::EmailAddress
  validates_format_of attr_names, format_configuration
  
  # Add length validation
  length_configuration = configuration.dup
  length_configuration.reverse_merge!(:within => 3..320) unless ([:minimum, :maximum, :is, :within, :in] & configuration.keys).any?
  validates_length_of attr_names, length_configuration
end