Validate/EmailAddress.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Validate
version: $Id: EmailAddress.php 22697 2010-07-26 21:14:47Z alexander $
Classes: Zend_Validate_EmailAddress

Description

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.

Zend_Validate_EmailAddress
jump to top

Extends from: Zend_Validate_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Validate
Constants: INVALID; INVALID_FORMAT; INVALID_HOSTNAME; INVALID_MX_RECORD; INVALID_SEGMENT; DOT_ATOM; QUOTED_STRING; INVALID_LOCAL_PART; LENGTH_EXCEEDED
Properties: $_messageTemplates; $_invalidIp; $_messageVariables; $_hostname; $_localPart; $_options
Methods: __construct; getOptions; setOptions; setMessage; getHostnameValidator; setHostnameValidator; validateMxSupported; getValidateMx; setValidateMx; getDeepMxCheck; setDeepMxCheck; getDomainCheck; setDomainCheck; _isReserved; _toIp; _validateLocalPart; _validateMXRecords; _validateHostnamePart; isValid

Description

Constants

INVALID
jump to class

 INVALID = 'emailAddressInvalid'

Details

value: emailAddressInvalid

INVALID_FORMAT
jump to class

 INVALID_FORMAT = 'emailAddressInvalidFormat'

Details

value: emailAddressInvalidFormat

INVALID_HOSTNAME
jump to class

 INVALID_HOSTNAME = 'emailAddressInvalidHostname'

Details

value: emailAddressInvalidHostname

INVALID_MX_RECORD
jump to class

 INVALID_MX_RECORD = 'emailAddressInvalidMxRecord'

Details

value: emailAddressInvalidMxRecord

INVALID_SEGMENT
jump to class

 INVALID_SEGMENT = 'emailAddressInvalidSegment'

Details

value: emailAddressInvalidSegment

DOT_ATOM
jump to class

 DOT_ATOM = 'emailAddressDotAtom'

Details

value: emailAddressDotAtom

QUOTED_STRING
jump to class

 QUOTED_STRING = 'emailAddressQuotedString'

Details

value: emailAddressQuotedString

INVALID_LOCAL_PART
jump to class

 INVALID_LOCAL_PART = 'emailAddressInvalidLocalPart'

Details

value: emailAddressInvalidLocalPart

LENGTH_EXCEEDED
jump to class

 LENGTH_EXCEEDED = 'emailAddressLengthExceeded'

Details

value: emailAddressLengthExceeded

Properties

$_hostname
jump to class

string $_hostname = ''

Details

$_hostname: string
visibility: protected
default
final: false
static: false

$_invalidIp
jump to class

array $_invalidIp = 'array'

Details

$_invalidIp: array
visibility: protected
default: array
final: false
static: false
see: http://en.wikipedia.org/wiki/IPv4

$_localPart
jump to class

string $_localPart = ''

Details

$_localPart: string
visibility: protected
default
final: false
static: false

$_messageTemplates
jump to class

array $_messageTemplates = 'array'

Details

$_messageTemplates: array
visibility: protected
default: array
final: false
static: false

$_messageVariables
jump to class

array $_messageVariables = 'array'

Details

$_messageVariables: array
visibility: protected
default: array
final: false
static: false

$_options
jump to class

$_options = 'array'

Internal options array

Details

visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__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

Arguments

$options: arrayZend_Config
OPTIONAL

Details

visibility: public
final: false
static: false

_isReserved
jump to class

_isReserved(
          string $host
          )
        
        :
        boolean

Returns if the given host is reserved

Arguments

$host: string

Output

boolean

Details

visibility: private
final: false
static: false

_toIp
jump to class

_toIp(
          string $binary
          )
        
        :
        mixed

Converts a binary string to an IP address

Arguments

$binary: string

Output

mixed

Details

visibility: private
final: false
static: false

_validateHostnamePart
jump to class

_validateHostnamePart(
          
          )
        
        :
        boolean

Internal method to validate the hostname part of the email address

Output

boolean

Details

visibility: private
final: false
static: false

_validateLocalPart
jump to class

_validateLocalPart(
          
          )
        
        :
        boolean

Internal method to validate the local part of the email address

Output

boolean

Details

visibility: private
final: false
static: false

_validateMXRecords
jump to class

_validateMXRecords(
          
          )
        
        :
        boolean

Internal method to validate the servers MX records

Output

boolean

Details

visibility: private
final: false
static: false

getDeepMxCheck
jump to class

getDeepMxCheck(
          
          )
        
        :
        boolean

Returns the set deepMxCheck option

Output

boolean

Details

visibility: public
final: false
static: false

getDomainCheck
jump to class

getDomainCheck(
          
          )
        
        :
        unknown

Returns the set domainCheck option

Output

unknown

Details

visibility: public
final: false
static: false

getHostnameValidator
jump to class

getHostnameValidator(
          
          )
        
        :
        Zend_Validate_Hostname

Returns the set hostname validator

Output

Zend_Validate_Hostname

Details

visibility: public
final: false
static: false

getOptions
jump to class

getOptions(
          
          )
        
        :
        array

Returns all set Options

Output

array

Details

visibility: public
final: false
static: false

getValidateMx
jump to class

getValidateMx(
          
          )
        
        :
        boolean

Returns the set validateMx option

Output

boolean

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          string $value
          )
        
        :
        boolean

Defined by Zend_Validate_Interface

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

Arguments

$value: string

Output

boolean

Details

visibility: public
final: false
static: false
link: RFC2822
link: US-ASCII characters

setDeepMxCheck
jump to class

setDeepMxCheck(
          boolean $deep
          )
        
        :
        Zend_Validate_EmailAddress

Set whether we check MX record should be a deep validation

Arguments

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

Output

Zend_Validate_EmailAddress: Fluid Interface

Details

visibility: public
final: false
static: false

setDomainCheck
jump to class

setDomainCheck(
          boolean $domain
              =
              true
          )
        
        :
        Zend_Validate_EmailAddress

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

Arguments

$domain: boolean

Output

Zend_Validate_EmailAddress: Fluid Interface

Details

visibility: public
final: false
static: false

setHostnameValidator
jump to class

setHostnameValidator(
          Zend_Validate_Hostname $hostnameValidator
              =
              null, int $allow
              =
              Zend_Validate_Hostname
          )
        
        :
        void

Arguments

$hostnameValidator: Zend_Validate_Hostname
OPTIONAL
$allow: int
OPTIONAL

Details

visibility: public
final: false
static: false

setMessage
jump to class

setMessage(
          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

Arguments

$messageString: string
$messageKey: string
OPTIONAL

Output

Zend_Validate_Abstract: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setOptions
jump to class

setOptions(
          array $options
              =
              array
          )
        
        :
        Zend_Validate_EmailAddress

Set options for the email validator

Arguments

$options: array

Output

Zend_Validate_EmailAddress: fluid interface

Details

visibility: public
final: false
static: false

setValidateMx
jump to class

setValidateMx(
          boolean $mx
          )
        
        :
        Zend_Validate_EmailAddress

Set whether we check for a valid MX record via DNS

This only applies when DNS hostnames are validated

Arguments

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

Output

Zend_Validate_EmailAddress: Fluid Interface

Details

visibility: public
final: false
static: false

validateMxSupported
jump to class

validateMxSupported(
          
          )
        
        :
        boolean

Whether MX checking via getmxrr is supported or not

This currently only works on UNIX systems

Output

boolean

Details

visibility: public
final: false
static: false

API Documentation

Validate/EmailAddress.php

Description

Zend_Validate_EmailAddressjump to top

Description

Constants

INVALIDjump to class

Details

INVALID_FORMATjump to class

Details

INVALID_HOSTNAMEjump to class

Details

INVALID_MX_RECORDjump to class

Details

INVALID_SEGMENTjump to class

Details

DOT_ATOMjump to class

Details

QUOTED_STRINGjump to class

Details

INVALID_LOCAL_PARTjump to class

Details

LENGTH_EXCEEDEDjump to class

Details

Properties

$_hostnamejump to class

Details

$_invalidIpjump to class

Details

$_localPartjump to class

Details

$_messageTemplatesjump to class

Details

$_messageVariablesjump to class

Details

$_optionsjump to class

Details

Methods

__constructjump to class

Arguments

Details

_isReservedjump to class

Arguments

Output

Details

_toIpjump to class

Arguments

Output

Details

_validateHostnamePartjump to class

Output

Details

_validateLocalPartjump to class

Output

Details

_validateMXRecordsjump to class

Output

Details

getDeepMxCheckjump to class

Output

Details

getDomainCheckjump to class

Output

Details

getHostnameValidatorjump to class

Output

Details

getOptionsjump to class

Output

Details

getValidateMxjump to class

Output

Details

isValidjump to class

Arguments

Output

Details

setDeepMxCheckjump to class

Arguments

Output

Zend_Validate_EmailAddress
jump to top

INVALID
jump to class

INVALID_FORMAT
jump to class

INVALID_HOSTNAME
jump to class

INVALID_MX_RECORD
jump to class

INVALID_SEGMENT
jump to class

DOT_ATOM
jump to class

QUOTED_STRING
jump to class

INVALID_LOCAL_PART
jump to class

LENGTH_EXCEEDED
jump to class

$_hostname
jump to class

$_invalidIp
jump to class

$_localPart
jump to class

$_messageTemplates
jump to class

$_messageVariables
jump to class

$_options
jump to class

__construct
jump to class

_isReserved
jump to class

_toIp
jump to class

_validateHostnamePart
jump to class

_validateLocalPart
jump to class

_validateMXRecords
jump to class

getDeepMxCheck
jump to class

getDomainCheck
jump to class

getHostnameValidator
jump to class

getOptions
jump to class

getValidateMx
jump to class

isValid
jump to class

setDeepMxCheck
jump to class

setDomainCheck
jump to class

setHostnameValidator
jump to class

setMessage
jump to class

setOptions
jump to class

setValidateMx
jump to class

validateMxSupported
jump to class