Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.Commands.EmailSyntaxValidator Class Reference

List of all members.

Public Member Functions

 EmailSyntaxValidator (string email, bool TLDrequired)
 Initializes a new instance of the EmailSyntaxValidator.

Static Public Member Functions

static bool Valid (string email, bool TLDrequired)
 Determines if an email has valid syntax.

Properties

bool IsValid [get]
 Gets a value indicating whether or not the email address has valid syntax.
string Domain [get]
 Get the domain part of the email address.
string Account [get]
 Get the account part of the email address.
string Address [get]
 Gets the email address as entered.

Constructor & Destructor Documentation

DOL.GS.Commands.EmailSyntaxValidator.EmailSyntaxValidator ( string  email,
bool  TLDrequired 
)

Initializes a new instance of the EmailSyntaxValidator.

Parameters:
emailthe email to test
TLDrequiredindicates whether or not the email must end with a known TLD to be considered valid

The initializer creates an instance of the EmailSyntaxValidator class to validate a single email. You can specify whether or not the TLD is required and should be validated.


Member Function Documentation

static bool DOL.GS.Commands.EmailSyntaxValidator.Valid ( string  email,
bool  TLDrequired 
) [static]

Determines if an email has valid syntax.

Parameters:
emailthe email to test
TLDrequiredindicates whether or not the email must end with a known TLD to be considered valid
Returns:
boolean indicating if the email has valid syntax

Validates an email address specifying whether or not the email is required to have a TLD that is valid.


Property Documentation

string DOL.GS.Commands.EmailSyntaxValidator.Account [get]

Get the account part of the email address.

This property returns the account part of the email address if and only if the email is considered valid by the class. Otherwise null is returned.

string representing the account of the email

string DOL.GS.Commands.EmailSyntaxValidator.Address [get]

Gets the email address as entered.

This property is filled regardless of the validity of the email. It contains the email as it was entered into the class.

string representing the email address as entered

string DOL.GS.Commands.EmailSyntaxValidator.Domain [get]

Get the domain part of the email address.

This property returns the domain part of the email address if and only if the email is considered valid by the class. Otherwise null is returned.

string representing the domain of the email

bool DOL.GS.Commands.EmailSyntaxValidator.IsValid [get]

Gets a value indicating whether or not the email address has valid syntax.

This property returns a boolean indicating whether or not the email address has valid syntax as determined by the class.

boolean indicating the validity of the email


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Properties Events