API Documentation
\

\Horde_Form_Type_email

Horde_Form_Type Class

Summary

Methods
Properties
Constants
getProperty()
__get()
setProperty()
__set()
init()
onSubmit()
isValid()
getTypeName()
getValues()
getInfo()
splitEmailAddresses()
validateEmailAddress()
validateEmailAddressSmtp()
getSize()
allowMulti()
about()
$_allow_multi
$_strip_domain
$_link_compose
$_check_smtp
$_link_name
$_delimiters
$_size
No constants found
_isRfc3696ValidEmailAddress()
_rfc3696StripComments()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$_allow_multi

$_allow_multi : boolean

Allow multiple addresses?

Type

boolean

$_strip_domain

$_strip_domain : boolean

Protect address from spammers?

Type

boolean

$_link_compose

$_link_compose : boolean

Link the email address to the compose page when displaying?

Type

boolean

$_check_smtp

$_check_smtp : boolean

Whether to check the domain's SMTP server whether the address exists.

Type

boolean

$_link_name

$_link_name : boolean

The name to use when linking to the compose page

Type

boolean

$_delimiters

$_delimiters : string

A string containing valid delimiters (default is just comma).

Type

string

$_size

$_size : integer

The size of the input field.

Type

integer

Methods

getProperty()

getProperty(  $property)

Parameters

$property

__get()

__get(  $property)

Parameters

$property

setProperty()

setProperty(  $property,   $value)

Parameters

$property
$value

__set()

__set(  $property,   $value)

Parameters

$property
$value

init()

init(boolean  $allow_multi = false, boolean  $strip_domain = false, boolean  $link_compose = false, string  $link_name = null, string  $delimiters = ',', integer  $size = null)

Initialize (kind of constructor) - Parameter list may vary on overloading

Parameters

boolean $allow_multi

Allow multiple addresses?
boolean $strip_domain

Protect address from spammers?
boolean $link_compose

Link the email address to the compose page when displaying?
string $link_name

The name to use when linking to the compose page.
string $delimiters

Character to split multiple addresses with.
integer $size

The size of the input field.

onSubmit()

onSubmit()

isValid()

isValid(  $var,   $vars,   $value,   $message)

Parameters

$var
$vars
$value
$message

getTypeName()

getTypeName()

getValues()

getValues()

getInfo()

getInfo(  $vars,   $var,   $info)

Parameters

$vars
$var
$info

splitEmailAddresses()

splitEmailAddresses(string  $string) : array

Explodes an RFC 2822 string, ignoring a delimiter if preceded by a "\" character, or if the delimiter is inside single or double quotes.

Parameters

string $string

The RFC 822 string.

Returns

array —

The exploded string in an array.

validateEmailAddress()

validateEmailAddress(string  $email) : boolean

Parameters

string $email

An individual email address to validate.

Returns

boolean

validateEmailAddressSmtp()

validateEmailAddressSmtp(string  $email) : boolean

Attempt partial delivery of mail to an address to validate it.

Parameters

string $email

An individual email address to validate.

Returns

boolean

getSize()

getSize()

allowMulti()

allowMulti()

about()

about()

Return info about field type.