EmailAddress
in package
implements
EmailAddressInterface
Class EmailAddress
Represents an email address (both email address and displayed name).
Tags
Interfaces, Classes and Traits
- EmailAddressInterface
- Interface EmailAddressInterface
Table of Contents
- MAX_LENGTH = 128
- Defines the max length of the database field.
- $emailAddress : string
- E-Mail address.
- __construct() : mixed
- Constructor
- __toString() : string
- Returns the email address as a string.
Constants
MAX_LENGTH
Defines the max length of the database field.
public
int
MAX_LENGTH
= 128
Properties
$emailAddress
E-Mail address.
protected
string
$emailAddress
Methods
__construct()
Constructor
public
__construct(string $p_emailAddress[, bool $encodeSpecialCharacters = true ]) : mixed
Executes the validation checks for the email address.
Parameters
- $p_emailAddress : string
-
E-Mail address.
- $encodeSpecialCharacters : bool = true
-
Optional (true), whether to encode the special unicode characters to ASCII.
Tags
Return values
mixed —__toString()
Returns the email address as a string.
public
__toString() : string
Return values
string —Equivalent string.