Packagemx.validators
Classpublic class EmailValidator
InheritanceEmailValidator Inheritance Validator Inheritance EventDispatcher Inheritance Object

The EmailValidator class validates that a String has a single @ sign, a period in the domain name and that the top-level domain suffix has two, three, four, or six characters. IP domain names are valid if they are enclosed in square brackets. The validator does not check whether the domain and user name actually exist.

You can use IP domain names if they are enclosed in square brackets; for example, myname@[206.132.22.1]. You can use individual IP numbers from 0 to 255.

MXML SyntaxexpandedHide MXML Syntax

The <mx:EmailValidator> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:EmailValidator 
    invalidCharError="Your e-mail address contains invalid characters."
    invalidDomainError= "The domain in your e-mail address is incorrectly formatted." 
    invalidIPDomainError="The IP domain in your e-mail address is incorrectly formatted." 
    invalidPeriodsInDomainError="The domain in your e-mail address has consecutive periods." 
    missingAtSignError="An at sign (&64;) is missing in your e-mail address."
    missingPeriodInDomainError="The domain in your e-mail address is missing a period." 
    missingUsernameError="The username in your e-mail address is missing." 
    tooManyAtSignsError="Your e-mail address contains too many &64; characters."
  />

View the examples


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedenabled : Boolean
Setting this value to false will stop the validator from performing validation.
Validator
  invalidCharError : String
Error message when there are invalid characters in the e-mail address.
EmailValidator
  invalidDomainError : String
Error message when the suffix (the top level domain) is not 2, 3, 4 or 6 characters long.
EmailValidator
  invalidIPDomainError : String
Error message when the IP domain is invalid.
EmailValidator
  invalidPeriodsInDomainError : String
Error message when there are continuous periods in the domain.
EmailValidator
 Inheritedlistener : Object
Specifies the validation listener.
Validator
  missingAtSignError : String
Error message when there is no at sign in the email address.
EmailValidator
  missingPeriodInDomainError : String
Error message when there is no period in the domain.
EmailValidator
  missingUsernameError : String
Error message when there is no username.
EmailValidator
 Inheritedproperty : String
A String specifying the name of the property of the source object that contains the value to validate.
Validator
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedrequired : Boolean = true
If true, specifies that a missing or empty value causes a validation error.
Validator
 InheritedrequiredFieldError : String
Error message when a value is missing and the required property is true.
Validator
 Inheritedsource : Object
Specifies the object containing the property to validate.
Validator
  tooManyAtSignsError : String
Error message when there is more than one at sign in the e-mail address.
EmailValidator
 Inheritedtrigger : IEventDispatcher
Specifies the component generating the event that triggers the validator.
Validator
 InheritedtriggerEvent : String
Specifies the event that triggers the validation.
Validator
Protected Properties
 PropertyDefined By
 InheritedactualListeners : Array
[read-only] Contains an Array of listener objects, if any, or the source object.
Validator
 InheritedactualTrigger : IEventDispatcher
[read-only] Contains the trigger object, if any, or the source object.
Validator
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
Validator
 InheritedsubFields : Array
An Array of Strings containing the names for the properties contained in the value Object passed to the validate() method.
Validator
Public Methods
 MethodDefined By
  
EmailValidator()
Constructor.
EmailValidator
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the Validator is created using an MXML tag.
Validator
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent
Performs validation and optionally notifies the listeners of the result.
Validator
 Inherited
validateAll(validators:Array):Array
[static] Invokes all the validators in the validators Array.
Validator
  
validateEmail(validator:EmailValidator, value:Object, baseField:String):Array
[static] Convenience method for calling a validator from within a custom validation function.
EmailValidator
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
addListenerHandler():void
Sets up all of the listeners for the valid and invalid events dispatched from the validator.
Validator
  
doValidation(value:Object):Array
[override] Override of the base class doValidation() method to validate an e-mail address.
EmailValidator
 Inherited
getValueFromSource():Object
Returns the Object to validate.
Validator
 Inherited
handleResults(errorResults:Array):ValidationResultEvent
Returns a ValidationResultEvent from the Array of error results.
Validator
 Inherited
isRealValue(value:Object):Boolean
Returns true if value is not null.
Validator
 Inherited
removeListenerHandler():void
Disconnects all of the listeners for the valid and invalid events dispatched from the validator.
Validator
 Inherited
resourcesChanged():void
This method is called when a Validator is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
Validator
Events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 Inherited
invalid
Dispatched when validation fails.Validator
 Inherited
valid
Dispatched when validation succeeds.Validator
Protected Constants
 ConstantDefined By
 InheritedDECIMAL_DIGITS : String = "0123456789"
[static] A String containing the decimal digits 0 through 9.
Validator
 InheritedROMAN_LETTERS : String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
[static] A string containing the upper- and lower-case letters of the Roman alphabet ("A" through "Z" and "a" through "z").
Validator
Property Detail
invalidCharErrorproperty
invalidCharError:String

Error message when there are invalid characters in the e-mail address.

The default value is "Your e-mail address contains invalid characters.".



Implementation
    public function get invalidCharError():String
    public function set invalidCharError(value:String):void
invalidDomainErrorproperty 
invalidDomainError:String

Error message when the suffix (the top level domain) is not 2, 3, 4 or 6 characters long.

The default value is "The domain in your e-mail address is incorrectly formatted.".



Implementation
    public function get invalidDomainError():String
    public function set invalidDomainError(value:String):void
invalidIPDomainErrorproperty 
invalidIPDomainError:String

Error message when the IP domain is invalid. The IP domain must be enclosed by square brackets.

The default value is "The IP domain in your e-mail address is incorrectly formatted.".



Implementation
    public function get invalidIPDomainError():String
    public function set invalidIPDomainError(value:String):void
invalidPeriodsInDomainErrorproperty 
invalidPeriodsInDomainError:String

Error message when there are continuous periods in the domain.

The default value is "The domain in your e-mail address has continous periods.".



Implementation
    public function get invalidPeriodsInDomainError():String
    public function set invalidPeriodsInDomainError(value:String):void
missingAtSignErrorproperty 
missingAtSignError:String

Error message when there is no at sign in the email address.

The default value is "An at sign (&64;) is missing in your e-mail address.".



Implementation
    public function get missingAtSignError():String
    public function set missingAtSignError(value:String):void
missingPeriodInDomainErrorproperty 
missingPeriodInDomainError:String

Error message when there is no period in the domain.

The default value is "The domain in your e-mail address is missing a period.".



Implementation
    public function get missingPeriodInDomainError():String
    public function set missingPeriodInDomainError(value:String):void
missingUsernameErrorproperty 
missingUsernameError:String

Error message when there is no username.

The default value is "The username in your e-mail address is missing.".



Implementation
    public function get missingUsernameError():String
    public function set missingUsernameError(value:String):void
tooManyAtSignsErrorproperty 
tooManyAtSignsError:String

Error message when there is more than one at sign in the e-mail address. This property is optional.

The default value is "Your e-mail address contains too many &64; characters.".



Implementation
    public function get tooManyAtSignsError():String
    public function set tooManyAtSignsError(value:String):void
Constructor Detail
EmailValidator()Constructor
public function EmailValidator()

Constructor.

Method Detail
doValidation()method
override protected function doValidation(value:Object):Array

Override of the base class doValidation() method to validate an e-mail address.

You do not call this method directly; Flex calls it as part of performing a validation. If you create a custom Validator class, you must implement this method.

Parameters

value:Object — Either a String or an Object to validate.

Returns
Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.
validateEmail()method 
public static function validateEmail(validator:EmailValidator, value:Object, baseField:String):Array

Convenience method for calling a validator from within a custom validation function. Each of the standard Flex validators has a similar convenience method.

Parameters

validator:EmailValidator — The EmailValidator instance.
 
value:Object — A field to validate.
 
baseField:String — Text representation of the subfield specified in the value parameter. For example, if the value parameter specifies value.email, the baseField value is "email".

Returns
Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

See also

mx.validators.ValidationResult
Examples How to use this example
EmailValidatorExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the EmailValidator. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:Script>
        import mx.controls.Alert;
    </mx:Script>

   <mx:EmailValidator source="{email}" property="text" 
       trigger="{myButton}" triggerEvent="click"
       valid="Alert.show('Validation Succeeded!');"/>

   <mx:Panel title="EmailValidator Example" width="75%" height="75%" 
        paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

        <mx:Form>
            <mx:FormItem label="Enter an e-mail address: ">
                <mx:TextInput id="email" width="100%"/>
            </mx:FormItem>

            <mx:FormItem >
                <mx:Button id="myButton" label="Validate" />
            </mx:FormItem>
        </mx:Form>
    </mx:Panel>
 </mx:Application>



© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Aug 13 2009, 03:11 AM -07:00