Class: JSONSchema::EmailOptions

Inherits:

Object

• Object
• JSONSchema::EmailOptions

Defined in:

sig/jsonschema.rbs

Overview

Email format validation options.

Instance Method Summary

• #allow_display_text ⇒ Boolean

  Whether display text is allowed.

• #allow_domain_literal ⇒ Boolean

  Whether domain literals are allowed.

• #initialize ⇒ Object constructor

  Create email validation options.

• #inspect ⇒ String
• #minimum_sub_domains ⇒ Integer^?

  Minimum number of subdomains.

• #require_tld ⇒ Boolean

  Whether TLD is required.

• #to_s ⇒ String

Constructor Details

#initialize ⇒ Object

Create email validation options.

Parameters:

• require_tld —

  Require top-level domain (default: false)

• allow_domain_literal —

  Allow domain literals like [127.0.0.1] (default: true)

• allow_display_text —

  Allow display names like "Name " (default: true)

• minimum_sub_domains —

  Minimum number of subdomains required (default: nil)

# File 'sig/jsonschema.rbs', line 654

def initialize: (

Instance Method Details

#allow_display_text ⇒ Boolean

Whether display text is allowed.

Returns:

• (Boolean)

# File 'sig/jsonschema.rbs', line 668

def allow_display_text: () -> bool

#allow_domain_literal ⇒ Boolean

Whether domain literals are allowed.

Returns:

• (Boolean)

# File 'sig/jsonschema.rbs', line 665

def allow_domain_literal: () -> bool

#inspect ⇒ String

Returns:

• (String)

# File 'sig/jsonschema.rbs', line 673

def inspect: () -> String

#minimum_sub_domains ⇒ Integer^?

Minimum number of subdomains.

Returns:

• (Integer, nil)

# File 'sig/jsonschema.rbs', line 671

def minimum_sub_domains: () -> Integer?

#require_tld ⇒ Boolean

Whether TLD is required.

Returns:

• (Boolean)

# File 'sig/jsonschema.rbs', line 662

def require_tld: () -> bool

#to_s ⇒ String

Returns:

• (String)

# File 'sig/jsonschema.rbs', line 674

def to_s: () -> String