Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
EmailValidator

Package | mx.validators
Class | public class EmailValidator
Inheritance | EmailValidator Validator flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 Syntax Show MXML Syntax
Hide 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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | enabled : 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
|  | listener : 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
|  | property : String A String specifying the name of the property of the source object that contains the value to validate. | Validator
|  | required : Boolean If true, specifies that a missing or empty value causes a validation error. | Validator
|  | requiredFieldError : String Error message when a value is missing and the required property is true. | Validator
|  | source : 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
|  | trigger : IEventDispatcher Specifies the component generating the event that triggers the validator. | Validator
|  | triggerEvent : String Specifies the event that triggers the validation. | Validator

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualListeners : Array [read-only] Contains an Array of listener objects, if any, or the source object. | Validator
|  | actualTrigger : IEventDispatcher [read-only] Contains the trigger object, if any, or the source object. | Validator
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | Validator
|  | subFields : Array An Array of Strings containing the names for the properties contained in the value Object passed to the validate() method. | Validator

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | EmailValidator() Constructor. | EmailValidator
|  | initialized(document:Object, id:String):void Called automatically by the MXML compiler when the Validator is created using an MXML tag. | Validator
|  | validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Performs validation and optionally notifies the listeners of the result. | Validator
|  | 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

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | 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
|  | getValueFromSource():Object Returns the Object to validate. | Validator
|  | handleResults(errorResults:Array):ValidationResultEvent Returns a ValidationResultEvent from the Array of error results. | Validator
|  | isRealValue(value:Object):Boolean Returns true if value is not null. | Validator
|  | removeListenerHandler():void Disconnects all of the listeners for the valid and invalid events dispatched from the validator. | Validator
|  | 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
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | invalid | Dispatched when validation fails. | Validator
|  | valid | Dispatched when validation succeeds. | Validator

Protected Constants
Hide Inherited Protected Constants
Show Inherited Protected Constants

| Constant | Defined By
--- | --- | ---
|  | DECIMAL_DIGITS : String = 0123456789 [static] A String containing the decimal digits 0 through 9. | Validator
|  | ROMAN_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

invalidCharError | property

`invalidCharError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

invalidDomainError | property |

`invalidDomainError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

invalidIPDomainError | property |

`invalidIPDomainError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

invalidPeriodsInDomainError | property |

`invalidPeriodsInDomainError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

missingAtSignError | property |

`missingAtSignError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

missingPeriodInDomainError | property |

`missingPeriodInDomainError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

missingUsernameError | property |

`missingUsernameError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

tooManyAtSignsError | property |

`tooManyAtSignsError:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Method Detail

doValidation | () | method

`override protected function doValidation(value:Object):Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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
EmailValidatorExample.mxml

    <?xml version="1.0" encoding="utf-8"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <!-- Simple example to demonstrate the EmailValidator. -->
    <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
            xmlns:s="library://ns.adobe.com/flex/spark"
            xmlns:mx="library://ns.adobe.com/flex/mx">

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

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

        <s:Panel title="EmailValidator Example"
                width="75%" height="75%"
                horizontalCenter="0" verticalCenter="0">
            <mx:Form left="10" right="10" top="10" bottom="10">
                <mx:FormItem label="Enter an e-mail address: ">
                    <s:TextInput id="email" width="100%"/>
                </mx:FormItem>
                <mx:FormItem >
                    <s:Button id="myButton" label="Validate" />
                </mx:FormItem>
            </mx:Form>
        </s:Panel>

    </s:Application>

Wed Nov 15 2017, 09:50 AM +01:00