class Assert::Assertions::Email(PropertyType)

• Assert::Assertions::Email(PropertyType)
• Assert::Assertions::Assertion
• Reference
• Object

Overview

Validates a property is a properly formatted email.

Optional Arguments

• mode - Which validation pattern to use. See EmailValidationMode.
• normalizer - Execute a Proc to alter actual before checking its validity.

Example

class Example
  include Assert

  def initialize; end

  @[Assert::Email]
  property loose_email : String = "example@-example.com"

  @[Assert::Email(mode: :html5)]
  property strict_email : String = "example@example.co.uk"

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

Example.new.valid? # => true

Defined in:

Constructors

• .new(property_name : String, actual : Union(String, Nil), mode : EmailValidationMode = EmailValidationMode::Loose, normalizer : Proc(String, String)? = nil, message : String? = nil, groups : Array(String)? = nil)

Instance Method Summary

• #default_message_template : String

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

• #message : String

  The message to display if self is not valid.

• #valid? : Bool

  Returns true if a property satisfies self, otherwise false.

Constructor Detail

Instance Method Detail