class Assert::Assertions::Email(PropertyType)

Overview

Validates a property is a properly formatted email.

Optional Arguments

Example

class Example
  include Assert

  def initialize; end

  @[Assert::Email]
  property loose_email : String = "[email protected]"

  @[Assert::Email(mode: :html5)]
  property strict_email : String = "[email protected]"

  @[Assert::Email(mode: :html5, normalizer: ->(actual : String) { actual.strip })]
  property strict_email_normalizer : String = "  [email protected]  "
end

Example.new.valid? # => true

Defined in:

assertions/email.cr

Constructors

Instance Method Summary

Instance methods inherited from class Assert::Assertions::Assertion

default_message_template : String default_message_template, groups : Array(String) groups, message : String message, message_template : String message_template, property_name : String property_name, valid? : Bool valid?

Constructor methods inherited from class Assert::Assertions::Assertion

new(property_name : String, message : String | Nil = nil, groups : Array(String) | Nil = nil) new

Constructor Detail

def self.new(property_name : String, actual : Union(String, Nil), mode : EmailValidationMode = EmailValidationMode::Loose, normalizer : Proc(String, String) | Nil = nil, message : String | Nil = nil, groups : Array(String) | Nil = nil) #

[View source]

Instance Method Detail

def default_message_template : String #

Returns the default #message_template to use if no message is provided.


[View source]
def message : String #

The message to display if self is not valid.

NOTE This method is defined automatically, and is just present for documentation purposes.


[View source]
def valid? : Bool #

Returns true if a property satisfies self, otherwise false.


[View source]