Class: STRemailAddresses

Source Location: /STRemailAddresses.php

Class Overview

Strings
   |
   --STRemailAddresses

This class manages STRemailAddresses objects. It is used to manipulate email addresses strings.

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Inherited Variables

Class: Strings

Strings::$api_render
Strings::$charset
Strings::$colors
Strings::$directoutput
Strings::$error
Strings::$msgtypes
Strings::$value

Inherited Methods

Class: Strings

Strings::__construct(): Construction function
Strings::console(): Console function
Strings::IsUTF8(): UTF8 detection function
Strings::QuoteStrip(): Quotes stripping function
Strings::RemoveAccent(): Accents removal function
Strings::RemoveSpaces(): Spaces removal function
Strings::stringHasNumbers(): Numbers detection function
Strings::ToUTF8(): UTF8 conversion function
Strings::ucwordsw(): Special uppercase function

Class Details

[line 36]
This class manages STRemailAddresses objects. It is used to manipulate email addresses strings.

Created on 29 aug 06

Changes: 2.0 -> 2.1: 27 jul 09 updated: file is PEAR compatible name of class has been changed from Email_Addresses to STRemailAddresses 1.0 to 2.0: 23 jun 09 updated: phpdoc compatible in the way to generate documentation

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	2.1
license:	GNU Public License

[ Top ]

Class Methods

method validateEmail [line 61]

bool validateEmail(
[bool
$light = false], [bool
$nullable = false], string
$this->value)

Email address validation function

This function is used to validate an email address Result is returned

<?php
$oEmail = new STRemailAddresses("pvienne@me.com");
echo $oEmail->validateEmail();
// 1
?>

Tags:

return:	true if email is valid
since:	version 1.0
usedby:	WBuser::updateWBuser()
usedby:	WBuser::createWBuser()

Parameters:

string	$this->value	value to be checked (required)
bool	$light	flag defining if check must validate MX or not
bool	$nullable	flag defiing if $this->value can be null or not

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:30:45 +0200 by phpDocumentor 1.4.1