CEmailValidator

Property Details

allowEmpty property

public boolean $allowEmpty;

whether the attribute value can be null or empty. Defaults to true, meaning that if the attribute is empty, it is considered valid.

allowName property

public boolean $allowName;

whether to allow name in the email address (e.g. "Qiang Xue "). Defaults to false.

checkMX property

public boolean $checkMX;

whether to check the MX record for the email address. Defaults to false. To enable it, you need to make sure the PHP function 'checkdnsrr' exists in your PHP installation. Please note that this check may fail due to temporary problems even if email is deliverable.

checkPort property

public boolean $checkPort;

whether to check port 25 for the email address. Defaults to false. To enable it, ensure that the PHP functions 'dns_get_record' and 'fsockopen' are available in your PHP installation. Please note that this check may fail due to temporary problems even if email is deliverable.

fullPattern property

public string $fullPattern;

the regular expression used to validate email addresses with the name part. This property is used only when allowName is true.

pattern property

public string $pattern;

the regular expression used to validate the attribute value.

timeout property (available since v1.1.19)

public null|int $timeout;

timeout to use when attempting to open connection to port in checkMxPorts. If null (default) use default_socket_timeout value from php.ini. If not null the timeout is set in seconds.

validateIDN property (available since v1.1.13)

public boolean $validateIDN;

whether validation process should care about IDN (internationalized domain names). Default value is false which means that validation of emails containing IDN will always fail.

Method Details

checkMxPorts() method (available since v1.1.11)

protected boolean checkMxPorts(string $domain)

protected function checkMxPorts($domain)
{
    $records=dns_get_record($domain, DNS_MX);
    if($records===false || empty($records))
        return false;
    $timeout=is_int($this->timeout)?$this->timeout:((int)ini_get('default_socket_timeout'));
    usort($records,array($this,'mxSort'));
    foreach($records as $record)
    {
        $handle=@fsockopen($record['target'],25,$errno,$errstr,$timeout);
        if($handle!==false)
        {
            fclose($handle);
            return true;
        }
    }
    return false;
}

Retrieves the list of MX records for $domain and checks if port 25 is opened on any of these.

clientValidateAttribute() method (available since v1.1.7)

public string clientValidateAttribute(CModel $object, string $attribute)

public function clientValidateAttribute($object,$attribute)
{
    if($this->validateIDN)
    {
        Yii::app()->getClientScript()->registerCoreScript('punycode');
        // punycode.js works only with the domains - so we have to extract it before punycoding
        $validateIDN='
var info = value.match(/^(.[^@]+)@(.+)$/);
if (info)
value = info[1] + "@" + punycode.toASCII(info[2]);
';
    }
    else
        $validateIDN='';

    $message=$this->message!==null ? $this->message : Yii::t('yii','{attribute} is not a valid email address.');
    $message=strtr($message, array(
        '{attribute}'=>$object->getAttributeLabel($attribute),
    ));

    $condition="!value.match({$this->pattern})";
    if($this->allowName)
        $condition.=" && !value.match({$this->fullPattern})";

    return "
$validateIDN
if(".($this->allowEmpty ? "jQuery.trim(value)!='' && " : '').$condition.") {
messages.push(".CJSON::encode($message).");
}
";
}

Returns the JavaScript needed for performing client-side validation.

mxSort() method (available since v1.1.11)

protected boolean mxSort(mixed $a, mixed $b)

protected function mxSort($a, $b)
{
    return $a['pri']-$b['pri'];
}

Determines if one MX record has higher priority as another (i.e. 'pri' is lower). Used by checkMxPorts.

validateAttribute() method

protected void validateAttribute(CModel $object, string $attribute)

protected function validateAttribute($object,$attribute)
{
    $value=$object->$attribute;
    if($this->allowEmpty && $this->isEmpty($value))
        return;

    if(!$this->validateValue($value))
    {
        $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} is not a valid email address.');
        $this->addError($object,$attribute,$message);
    }
}

Validates the attribute of the object. If there is any error, the error message is added to the object.

validateValue() method (available since v1.1.1)

public boolean validateValue(mixed $value)

public function validateValue($value)
{
    if(is_string($value) && $this->validateIDN)
        $value=$this->encodeIDN($value);
    // make sure string length is limited to avoid DOS attacks
    $valid=is_string($value) && strlen($value)<=254 && (preg_match($this->pattern,$value) || $this->allowName && preg_match($this->fullPattern,$value));
    if($valid)
        $domain=rtrim(substr($value,strpos($value,'@')+1),'>');
    if($valid && $this->checkMX && function_exists('checkdnsrr'))
        $valid=checkdnsrr($domain,'MX');
    if($valid && $this->checkPort && function_exists('fsockopen') && function_exists('dns_get_record'))
        $valid=$this->checkMxPorts($domain);
    return $valid;
}

Validates a static value to see if it is a valid email. This method is provided so that you can call it directly without going through the model validation rule mechanism.

Note that this method does not respect the allowEmpty property.