Inheritance diagram for Zend_Validate_EmailAddress:

Public Member Functions
	__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 ()

Data Fields
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 Attributes
	$_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

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)

Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)

	_implodeRecursive (array $pieces)

	_error ($messageKey, $value=null)

	_setValue ($value)

Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator

static	$_messageLength = -1

Detailed Description

Definition at line 38 of file EmailAddress.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $options = array() )

Instantiates hostname validator for local use

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

Parameters

array | string | Zend_Config $options OPTIONAL

Definition at line 137 of file EmailAddress.php.

     {
         if ($options instanceof Zend_Config) {
             $options = $options->toArray();
         } else if (!is_array($options)) {
             $options = func_get_args();
             $temp['allow'] = array_shift($options);
             if (!empty($options)) {
                 $temp['mx'] = array_shift($options);
             }
 
             if (!empty($options)) {
                 $temp['hostname'] = array_shift($options);
             }
 
             $options = $temp;
         }
 
         $options += $this->_options;
         $this->setOptions($options);
     }

Member Function Documentation

◆ getDeepMxCheck()

getDeepMxCheck ( )

Returns the set deepMxCheck option

Returns: boolean

Definition at line 304 of file EmailAddress.php.

     {
         return $this->_options['deep'];
     }

◆ getDomainCheck()

getDomainCheck ( )

Returns the set domainCheck option

Returns: unknown

Definition at line 326 of file EmailAddress.php.

     {
         return $this->_options['domain'];
     }

◆ getHostnameValidator()

getHostnameValidator ( )

Returns the set hostname validator

Returns: Zend_Validate_Hostname

Definition at line 236 of file EmailAddress.php.

     {
         return $this->_options['hostname'];
     }

◆ getOptions()

getOptions ( )

Returns all set Options

Returns: array

Definition at line 164 of file EmailAddress.php.

     {
         return $this->_options;
     }

◆ getValidateMx()

getValidateMx ( )

Returns the set validateMx option

Returns: boolean

Definition at line 274 of file EmailAddress.php.

     {
         return $this->_options['mx'];
     }

◆ isValid()

isValid ( $value )

Defined by Zend_Validate_Interface

Returns true if and only if $value is a valid email address according to RFC2822

RFC2822 http://www.columbia.edu/kermit/ascii.html US-ASCII characters string $value boolean

Implements Zend_Validate_Interface.

Definition at line 532 of file EmailAddress.php.

     {
         if (!is_string($value)) {
             $this->_error(self::INVALID);
             return false;
         }
 
         $matches = array();
         $length  = true;
         $this->_setValue($value);
 
         // Split email address up and disallow '..'
         if ((strpos($value, '..') !== false) or
             (!preg_match('/^(.+)@([^@]+)$/', $value, $matches))) {
             $this->_error(self::INVALID_FORMAT);
             return false;
         }
 
         $this->_localPart = $matches[1];
         $this->_hostname  = $matches[2];
 
         if ((strlen($this->_localPart) > 64) || (strlen($this->_hostname) > 255)) {
             $length = false;
             $this->_error(self::LENGTH_EXCEEDED);
         }
 
         // Match hostname part
         if ($this->_options['domain']) {
             $hostname = $this->_validateHostnamePart();
         }
 
         $local = $this->_validateLocalPart();
 
         // If both parts valid, return true
         if ($local && $length) {
             if (($this->_options['domain'] && $hostname) || !$this->_options['domain']) {
                 return true;
             }
         }
 
         return false;
     }

◆ setDeepMxCheck()

setDeepMxCheck ( $deep )

Set whether we check MX record should be a deep validation

Parameters

boolean $deep Set deep to true to perform a deep validation process for MX records

Returns: Zend_Validate_EmailAddress Provides a fluent inteface

Definition at line 315 of file EmailAddress.php.

     {
         $this->_options['deep'] = (bool) $deep;
         return $this;
     }

◆ setDomainCheck()

setDomainCheck ( $domain = true )

Sets if the domain should also be checked or only the local part of the email address

Parameters

boolean $domain

Returns: Zend_Validate_EmailAddress Provides a fluent inteface

Definition at line 338 of file EmailAddress.php.

     {
         $this->_options['domain'] = (boolean) $domain;
         return $this;
     }

◆ setHostnameValidator()

setHostnameValidator	(	Zend_Validate_Hostname	$hostnameValidator = `null`,
			$allow = `Zend_Validate_Hostname::ALLOW_DNS`
	)

Parameters

Zend_Validate_Hostname	$hostnameValidator	OPTIONAL
int	$allow	OPTIONAL

Returns: $this

Definition at line 246 of file EmailAddress.php.

     {
         if (!$hostnameValidator) {
             $hostnameValidator = new Zend_Validate_Hostname($allow);
         }
 
         $this->_options['hostname'] = $hostnameValidator;
         $this->_options['allow']    = $allow;
         return $this;
     }

◆ setMessage()

setMessage	(	$messageString,
		$messageKey = `null`
	)

Sets the validation failure message template for a particular key Adds the ability to set messages to the attached hostname validator

Parameters

string	$messageString
string	$messageKey	OPTIONAL

Returns: Zend_Validate_Abstract Provides a fluent interface

Exceptions

Zend_Validate_Exception

Definition at line 215 of file EmailAddress.php.

     {
         if ($messageKey === null) {
             $this->_options['hostname']->setMessage($messageString);
             parent::setMessage($messageString);
             return $this;
         }
 
         if (!isset($this->_messageTemplates[$messageKey])) {
             $this->_options['hostname']->setMessage($messageString, $messageKey);
         }
 
         $this->_messageTemplates[$messageKey] = $messageString;
         return $this;
     }

◆ setOptions()

setOptions ( array $options = array() )

Set options for the email validator

Parameters

array $options

Returns: Zend_Validate_EmailAddress Provides a fluent inteface

Definition at line 175 of file EmailAddress.php.

     {
         if (array_key_exists('messages', $options)) {
             $this->setMessages($options['messages']);
         }
 
         if (array_key_exists('hostname', $options)) {
             if (array_key_exists('allow', $options)) {
                 $this->setHostnameValidator($options['hostname'], $options['allow']);
             } else {
                 $this->setHostnameValidator($options['hostname']);
             }
         } elseif ($this->_options['hostname'] == null) {
             $this->setHostnameValidator();
         }
 
         if (array_key_exists('mx', $options)) {
             $this->setValidateMx($options['mx']);
         }
 
         if (array_key_exists('deep', $options)) {
             $this->setDeepMxCheck($options['deep']);
         }
 
         if (array_key_exists('domain', $options)) {
             $this->setDomainCheck($options['domain']);
         }
 
         return $this;
     }

◆ setValidateMx()

setValidateMx ( $mx )

Set whether we check for a valid MX record via DNS

This only applies when DNS hostnames are validated

Parameters

boolean $mx Set allowed to true to validate for MX records, and false to not validate them

Exceptions

Zend_Validate_Exception

Returns: Zend_Validate_EmailAddress Provides a fluent inteface

Definition at line 288 of file EmailAddress.php.

     {
         if ((bool) $mx && !$this->validateMxSupported()) {
             #require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception('MX checking not available on this system');
         }
 
         $this->_options['mx'] = (bool) $mx;
         return $this;
     }

◆ validateMxSupported()

validateMxSupported ( )

Whether MX checking via getmxrr is supported or not

This currently only works on UNIX systems

Returns: boolean

Definition at line 264 of file EmailAddress.php.

     {
         return function_exists('getmxrr');
     }

Field Documentation

◆ $_hostname

$_hostname

protected

Definition at line 108 of file EmailAddress.php.

◆ $_invalidIp

$_invalidIp

protected

Initial value:

= array(
        '0'   => '0.0.0.0/8',
        '10'  => '10.0.0.0/8',
        '100' => '100.64.0.0/10',
        '127' => '127.0.0.0/8',
        '169' => '169.254.0.0/16',
        '172' => '172.16.0.0/12',
        '192' => array(
            '192.0.0.0/24',
            '192.0.2.0/24',
            '192.88.99.0/24',
            '192.168.0.0/16'
        ),
        '198' => '198.18.0.0/15',
        '224' => '224.0.0.0/4',
        '240' => '240.0.0.0/4'
    )

Definition at line 79 of file EmailAddress.php.

◆ $_localPart

$_localPart

protected

Definition at line 113 of file EmailAddress.php.

◆ $_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::INVALID            => "Invalid type given. String expected",
        self::INVALID_FORMAT     => "'%value%' is not a valid email address in the basic format local-part@hostname",
        self::INVALID_HOSTNAME   => "'%hostname%' is not a valid hostname for email address '%value%'",
        self::INVALID_MX_RECORD  => "'%hostname%' does not appear to have a valid MX record for the email address '%value%'",
        self::INVALID_SEGMENT    => "'%hostname%' is not in a routable network segment. The email address '%value%' should not be resolved from public network",
        self::DOT_ATOM           => "'%localPart%' can not be matched against dot-atom format",
        self::QUOTED_STRING      => "'%localPart%' can not be matched against quoted-string format",
        self::INVALID_LOCAL_PART => "'%localPart%' is not a valid local part for email address '%value%'",
        self::LENGTH_EXCEEDED    => "'%value%' exceeds the allowed length",
    )

Definition at line 53 of file EmailAddress.php.

◆ $_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'hostname'  => '_hostname',
        'localPart' => '_localPart'
    )

Definition at line 100 of file EmailAddress.php.

◆ $_options

$_options

protected

Initial value:

= array(
        'mx'       => false,
        'deep'     => false,
        'domain'   => true,
        'allow'    => Zend_Validate_Hostname::ALLOW_DNS,
        'hostname' => null
    )

Internal options array

Definition at line 118 of file EmailAddress.php.

◆ DOT_ATOM

const DOT_ATOM = 'emailAddressDotAtom'

Definition at line 45 of file EmailAddress.php.

◆ INVALID

const INVALID = 'emailAddressInvalid'

Definition at line 40 of file EmailAddress.php.

◆ INVALID_FORMAT

const INVALID_FORMAT = 'emailAddressInvalidFormat'

Definition at line 41 of file EmailAddress.php.

◆ INVALID_HOSTNAME

const INVALID_HOSTNAME = 'emailAddressInvalidHostname'

Definition at line 42 of file EmailAddress.php.

◆ INVALID_LOCAL_PART

const INVALID_LOCAL_PART = 'emailAddressInvalidLocalPart'

Definition at line 47 of file EmailAddress.php.

◆ INVALID_MX_RECORD

const INVALID_MX_RECORD = 'emailAddressInvalidMxRecord'

Definition at line 43 of file EmailAddress.php.

◆ INVALID_SEGMENT

const INVALID_SEGMENT = 'emailAddressInvalidSegment'

Definition at line 44 of file EmailAddress.php.

◆ LENGTH_EXCEEDED

const LENGTH_EXCEEDED = 'emailAddressLengthExceeded'

Definition at line 48 of file EmailAddress.php.

◆ QUOTED_STRING

const QUOTED_STRING = 'emailAddressQuotedString'

Definition at line 46 of file EmailAddress.php.

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

vendor/magento/zendframework1/library/Zend/Validate/EmailAddress.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDeepMxCheck()

◆ getDomainCheck()

◆ getHostnameValidator()

◆ getOptions()

◆ getValidateMx()

◆ isValid()

◆ setDeepMxCheck()

◆ setDomainCheck()

◆ setHostnameValidator()

◆ setMessage()

◆ setOptions()

◆ setValidateMx()

◆ validateMxSupported()

Field Documentation

◆ $_hostname

◆ $_invalidIp

◆ $_localPart

◆ $_messageTemplates

◆ $_messageVariables

◆ $_options

◆ DOT_ATOM

◆ INVALID

◆ INVALID_FORMAT

◆ INVALID_HOSTNAME

◆ INVALID_LOCAL_PART

◆ INVALID_MX_RECORD

◆ INVALID_SEGMENT

◆ LENGTH_EXCEEDED

◆ QUOTED_STRING