Documentation

Horde_Core_Form_Type_Email extends Horde_Core_Form_Type
in package

Email

Table of Contents

$_allow_multi  : bool
Allow multiple addresses?
$_check_smtp  : bool
Contact the target mail server to see if the email address is deliverable?
$_delimiters  : string
The character to separate multiple email addresses
$_link_compose  : bool
Make displayed email addresses clickable?
$_link_name  : bool
The compose name to use
$_strip_domain  : bool
Strip domain from the address?
$_properties  : mixed
__construct()  : mixed
Type constructor. Takes a hash of key/value parameters.
__get()  : mixed
To get the 'escape' property of a type: $escape = $type->escape; If the property is not set this will return null.
__isset()  : mixed
To check if a type has a property named 'escape': if (isset($type->escape)) { ... }
__set()  : mixed
To set the 'escape' property of a type to true: $type->escape = true;
__unset()  : mixed
To unset a Type property named 'escape': unset($type->escape);
getInfo()  : mixed
init()  : mixed
isValid()  : mixed
onSubmit()  : mixed
splitEmailAddresses()  : array<string|int, mixed>
Explodes an RFC 2822 string, ignoring a delimiter if preceded by a "\" character, or if the delimiter is inside single or double quotes.
validateEmailAddress()  : bool
RFC(2)822 Email Parser.
validateEmailAddressSmtp()  : bool
Attempt partial delivery of mail to an address to validate it.
_defineValidationRegexps()  : mixed
RFC(2)822 Email Parser.

Properties

$_allow_multi

Allow multiple addresses?

public bool $_allow_multi = alse
Tags
type

boolean

$_check_smtp

Contact the target mail server to see if the email address is deliverable?

public bool $_check_smtp = alse
Tags
type

boolean

$_delimiters

The character to separate multiple email addresses

public string $_delimiters = ','
Tags
type

text

Make displayed email addresses clickable?

public bool $_link_compose = alse
Tags
type

boolean

The compose name to use

public bool $_link_name
Tags
type

text

$_strip_domain

Strip domain from the address?

public bool $_strip_domain = alse
Tags
type

boolean

$_properties

protected mixed $_properties = array()

Methods

__construct()

Type constructor. Takes a hash of key/value parameters.

public __construct([array<string|int, mixed> $properties = array() ]) : mixed
Parameters
$properties : array<string|int, mixed> = array()

Any type properties to initialize.

Return values
mixed

__get()

To get the 'escape' property of a type: $escape = $type->escape; If the property is not set this will return null.

public __get(string $property) : mixed
Parameters
$property : string

The property to retrieve.

Return values
mixed

__isset()

To check if a type has a property named 'escape': if (isset($type->escape)) { ... }

public __isset(string $property) : mixed
Parameters
$property : string

Property name to check existance of.

Return values
mixed

__set()

To set the 'escape' property of a type to true: $type->escape = true;

public __set(string $property, mixed $value) : mixed
Parameters
$property : string

The property name to set.

$value : mixed

The property value.

Return values
mixed

__unset()

To unset a Type property named 'escape': unset($type->escape);

public __unset(string $property) : mixed
Parameters
$property : string

Property name to unset.

Return values
mixed

getInfo()

public getInfo(mixed $vars, mixed $var, mixed &$info) : mixed
Parameters
$vars : mixed
$var : mixed
$info : mixed
Return values
mixed

init()

public init([mixed $allow_multi = false ][, mixed $strip_domain = false ][, mixed $link_compose = false ][, mixed $link_name = null ][, mixed $delimiters = ',' ]) : mixed
Parameters
$allow_multi : mixed = false
$strip_domain : mixed = false
$link_compose : mixed = false
$link_name : mixed = null
$delimiters : mixed = ','
Return values
mixed

isValid()

public isValid(mixed $var, mixed $vars, mixed $value, mixed &$message) : mixed
Parameters
$var : mixed
$vars : mixed
$value : mixed
$message : mixed
Return values
mixed

onSubmit()

public onSubmit() : mixed
Return values
mixed

splitEmailAddresses()

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

public splitEmailAddresses(string $string) : array<string|int, mixed>
Parameters
$string : string

The RFC 822 string.

Return values
array<string|int, mixed>

The exploded string in an array.

validateEmailAddress()

RFC(2)822 Email Parser.

public validateEmailAddress(string $email) : bool

By Cal Henderson cal@iamcal.com This code is licensed under a Creative Commons Attribution-ShareAlike 2.5 License http://creativecommons.org/licenses/by-sa/2.5/

http://code.iamcal.com/php/rfc822/

http://iamcal.com/publish/articles/php/parsing_email

Revision 4

Parameters
$email : string

An individual email address to validate.

Return values
bool

validateEmailAddressSmtp()

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

public validateEmailAddressSmtp(string $email) : bool
Parameters
$email : string

An individual email address to validate.

Return values
bool

_defineValidationRegexps()

RFC(2)822 Email Parser.

protected _defineValidationRegexps(string &$comment, string &$addr_spec) : mixed

By Cal Henderson cal@iamcal.com This code is licensed under a Creative Commons Attribution-ShareAlike 2.5 License http://creativecommons.org/licenses/by-sa/2.5/

http://code.iamcal.com/php/rfc822/

http://iamcal.com/publish/articles/php/parsing_email

Revision 4

Parameters
$comment : string

The regexp for comments.

$addr_spec : string

The regexp for email addresses.

Return values
mixed

Search results