EmailAddress Class Reference

Inheritance diagram for EmailAddress:

Public Member Functions
	__construct ($options=[])
	setValidateTld (bool $shouldValidate)
Public Member Functions inherited from Zend_Validate_EmailAddress
	__construct ($options=array())
	getOptions ()
	setOptions (array $options=array())
	setMessage ($messageString, $messageKey=null)
	getHostnameValidator ()
	setHostnameValidator (Zend_Validate_Hostname $hostnameValidator=null, $allow=Zend_Validate_Hostname::ALLOW_DNS)
	validateMxSupported ()
	getValidateMx ()
	setValidateMx ($mx)
	getDeepMxCheck ()
	setDeepMxCheck ($deep)
	getDomainCheck ()
	setDomainCheck ($domain=true)
	isValid ($value)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()
Public Member Functions inherited from ValidatorInterface
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Data Fields inherited from Zend_Validate_EmailAddress
const	INVALID = 'emailAddressInvalid'
const	INVALID_FORMAT = 'emailAddressInvalidFormat'
const	INVALID_HOSTNAME = 'emailAddressInvalidHostname'
const	INVALID_MX_RECORD = 'emailAddressInvalidMxRecord'
const	INVALID_SEGMENT = 'emailAddressInvalidSegment'
const	DOT_ATOM = 'emailAddressDotAtom'
const	QUOTED_STRING = 'emailAddressQuotedString'
const	INVALID_LOCAL_PART = 'emailAddressInvalidLocalPart'
const	LENGTH_EXCEEDED = 'emailAddressLengthExceeded'
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Protected Attributes inherited from Zend_Validate_EmailAddress
	$_messageTemplates
	$_invalidIp
	$_messageVariables
	$_hostname
	$_localPart
	$_options
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 10 of file EmailAddress.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = []

)

Instantiates hostname validator for local use. TLD validation is off by default.

The following option keys are supported: 'hostname' => A hostname validator, see Zend_Validate_Hostname 'allow' => Options for the hostname validator, see Zend_Validate_Hostname::ALLOW_* 'mx' => If MX check should be enabled, boolean 'deep' => If a deep MX check should be done, boolean

Definition at line 24 of file EmailAddress.php.

    {
        parent::__construct($options);

        $this->getHostnameValidator()->setValidateTld(false);
    }

Member Function Documentation

setValidateTld()

setValidateTld

(

bool

$shouldValidate

)

Sets whether or not top-level domains should be validated

Parameters

bool

$shouldValidate

Returns

void

Definition at line 37 of file EmailAddress.php.

    {
        $this->getHostnameValidator()->setValidateTld($shouldValidate);
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Validator/EmailAddress.php