API Documentation

Validate/EmailAddress.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Validate  
version
$Id: EmailAddress.php 24304 2011-07-30 01:12:35Z adamlundrigan $  

\Zend_Validate_EmailAddress

Extends from
\Zend_Validate_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Validate  

Constants

Constant  INVALID = 'emailAddressInvalid'
Constant  INVALID_FORMAT = 'emailAddressInvalidFormat'
Constant  INVALID_HOSTNAME = 'emailAddressInvalidHostname'
Constant  INVALID_MX_RECORD = 'emailAddressInvalidMxRecord'
Constant  INVALID_SEGMENT = 'emailAddressInvalidSegment'
Constant  DOT_ATOM = 'emailAddressDotAtom'
Constant  QUOTED_STRING = 'emailAddressQuotedString'
Constant  INVALID_LOCAL_PART = 'emailAddressInvalidLocalPart'
Constant  LENGTH_EXCEEDED = 'emailAddressLengthExceeded'

Properties

Propertyprotectedstring  $_hostname= ''

Details
Type
string
Propertyprotectedarray  $_invalidIp= 'array'

Default valuearrayDetails
Type
array
see
\http://en.wikipedia.org/wiki/IPv4  
Propertyprotectedstring  $_localPart= ''

Details
Type
string
Propertyprotectedarray  $_messageTemplates= 'array'

Validation failure message template definitions

Default valuearrayDetails
Type
array
Propertyprotectedarray  $_messageVariables= 'array'

Additional variables available for validation failure messages

Default valuearrayDetails
Type
array
Propertyprotected  $_options= 'array'

Internal options array

Default valuearrayDetails
Type

Methods

methodpublic__construct( array|\Zend_Config $options = array ) : void

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
Name Type Description
$options array|\Zend_Config OPTIONAL
methodpublic__get( string $property ) : mixed

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

Inherited from: \Zend_Validate_Abstract::__get()
Parameters
Name Type Description
$property string
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Validate_Exception
methodprotected_createMessage( string $messageKey, string $value ) : string

Constructs and returns a validation failure message with the given message key and value.

Inherited from: \Zend_Validate_Abstract::_createMessage()

Returns null if and only if $messageKey does not correspond to an existing template.

If a translator is available and a translation exists for $messageKey, the translation will be used.

Parameters
Name Type Description
$messageKey string
$value string
Returns
Type Description
string
methodprotected_error( string $messageKey, string $value = null ) : void
Parameters
Name Type Description
$messageKey string
$value string OPTIONAL
methodprivate_isReserved( string $host ) : boolean

Returns if the given host is reserved

Parameters
Name Type Description
$host string
Returns
Type Description
boolean
methodprotected_setValue( mixed $value ) : void

Sets the value to be validated and clears the messages and errors arrays

Inherited from: \Zend_Validate_Abstract::_setValue()
Parameters
Name Type Description
$value mixed
methodprivate_toIp( string $binary ) : mixed

Converts a binary string to an IP address

Parameters
Name Type Description
$binary string
Returns
Type Description
mixed
methodprivate_validateHostnamePart( ) : boolean

Internal method to validate the hostname part of the email address

Returns
Type Description
boolean
methodprivate_validateLocalPart( ) : boolean

Internal method to validate the local part of the email address

Returns
Type Description
boolean
methodprivate_validateMXRecords( ) : boolean

Internal method to validate the servers MX records

Returns
Type Description
boolean
methodpublicgetDeepMxCheck( ) : boolean

Returns the set deepMxCheck option

Returns
Type Description
boolean
methodpublicgetDefaultTranslator( ) : \Zend_Translate_Adapter|null
static

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublicgetDomainCheck( ) : \unknown

Returns the set domainCheck option

Returns
Type Description
\unknown
methodpublicgetErrors( ) : array

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()
Returns
Type Description
array
Details
deprecated
Since 1.5.0  
methodpublicgetHostnameValidator( ) : \Zend_Validate_Hostname

Returns the set hostname validator

Returns
Type Description
\Zend_Validate_Hostname
methodpublicgetMessageLength( ) : integer
static

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()
Returns
Type Description
integer
methodpublicgetMessageTemplates( ) : array

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::getMessageTemplates()
Returns
Type Description
array
methodpublicgetMessageVariables( ) : array

Returns an array of the names of variables that are used in constructing validation failure messages

Inherited from: \Zend_Validate_Abstract::getMessageVariables()
Returns
Type Description
array
methodpublicgetMessages( ) : array

Returns array of validation failure messages

Inherited from: \Zend_Validate_Abstract::getMessages()

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

Returns
Type Description
array
methodpublicgetObscureValue( ) : bool

Retrieve flag indicating whether or not value should be obfuscated in messages

Inherited from: \Zend_Validate_Abstract::getObscureValue()
Returns
Type Description
bool
methodpublicgetOptions( ) : array

Returns all set Options

Returns
Type Description
array
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublicgetValidateMx( ) : boolean

Returns the set validateMx option

Returns
Type Description
boolean
methodpublichasDefaultTranslator( ) : boolean
static

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()
Returns
Type Description
boolean
methodpublichasTranslator( ) : bool

Does this validator have its own specific translator?

Inherited from: \Zend_Validate_Abstract::hasTranslator()
Returns
Type Description
bool
methodpublicisValid( string $value ) : boolean

Defined by Zend_Validate_Interface

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

Parameters
Name Type Description
$value string
Returns
Type Description
boolean
Throws
Exception Description
\Zend_Validate_Exception If validation of $value is impossible
Details
link
RFC2822  
link
US-ASCII characters  
methodpublicsetDeepMxCheck( boolean $deep ) : \Zend_Validate_EmailAddress

Set whether we check MX record should be a deep validation

Parameters
Name Type Description
$deep boolean Set deep to true to perform a deep validation process for MX records
Returns
Type Description
\Zend_Validate_EmailAddress Fluid Interface
methodpublicsetDefaultTranslator( \Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : void
static

Set default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()
Parameters
Name Type Description
$translator \Zend_Translate|\Zend_Translate_Adapter|null
methodpublicsetDisableTranslator( bool $flag ) : \Zend_Validate_Abstract

Indicate whether or not translation should be disabled

Inherited from: \Zend_Validate_Abstract::setDisableTranslator()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Validate_Abstract
methodpublicsetDomainCheck( boolean $domain = true ) : \Zend_Validate_EmailAddress

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

Parameters
Name Type Description
$domain boolean
Returns
Type Description
\Zend_Validate_EmailAddress Fluid Interface
methodpublicsetHostnameValidator( \Zend_Validate_Hostname $hostnameValidator = null, int $allow = Zend_Validate_Hostname ) : void

Parameters
Name Type Description
$hostnameValidator \Zend_Validate_Hostname OPTIONAL
$allow int OPTIONAL
methodpublicsetMessage( string $messageString, string $messageKey = null ) : \Zend_Validate_Abstract

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

Parameters
Name Type Description
$messageString string
$messageKey string OPTIONAL
Returns
Type Description
\Zend_Validate_Abstract Provides a fluent interface
Throws
Exception Description
\Zend_Validate_Exception
methodpublicsetMessageLength( integer $length ) : void
static

Sets the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::setMessageLength()
Parameters
Name Type Description
$length integer
methodpublicsetMessages( array $messages ) : \Zend_Validate_Abstract

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.

Inherited from: \Zend_Validate_Abstract::setMessages()
Parameters
Name Type Description
$messages array
Returns
Type Description
\Zend_Validate_Abstract
methodpublicsetObscureValue( bool $flag ) : \Zend_Validate_Abstract

Set flag indicating whether or not value should be obfuscated in messages

Inherited from: \Zend_Validate_Abstract::setObscureValue()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Validate_Abstract
methodpublicsetOptions( array $options = array ) : \Zend_Validate_EmailAddress

Set options for the email validator

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Validate_EmailAddress fluid interface
methodpublicsetTranslator( \Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : \Zend_Validate_Abstract

Set translation object

Inherited from: \Zend_Validate_Abstract::setTranslator()
Parameters
Name Type Description
$translator \Zend_Translate|\Zend_Translate_Adapter|null
Returns
Type Description
\Zend_Validate_Abstract
methodpublicsetValidateMx( boolean $mx ) : \Zend_Validate_EmailAddress

Set whether we check for a valid MX record via DNS

This only applies when DNS hostnames are validated

Parameters
Name Type Description
$mx boolean Set allowed to true to validate for MX records, and false to not validate them
Returns
Type Description
\Zend_Validate_EmailAddress Fluid Interface
methodpublictranslatorIsDisabled( ) : bool

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()
Returns
Type Description
bool
methodpublicvalidateMxSupported( ) : boolean

Whether MX checking via getmxrr is supported or not

This currently only works on UNIX systems

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.13.3.