Elgg  Version 3.0
Public Member Functions | Static Public Member Functions | List of all members
Elgg\Email\Address Class Reference

Email address. More...

Inheritance diagram for Elgg\Email\Address:

Public Member Functions

 setEmail ($email)
 Set the email address. More...
 
 setName ($name)
 Set the name. More...
 
 unsetName ()
 Clear the name from the email address. More...
 

Static Public Member Functions

static fromString ($contact, $ignored=null)
 Parses strings like "Evan <evan@elgg.org>" into name/email objects. More...
 
static getFormattedEmailAddress ($email, $name=null)
 Format an email address and name into a formatted email address. More...
 

Detailed Description

Email address.

Since
3.0

Definition at line 15 of file Address.php.

Member Function Documentation

static Elgg\Email\Address::fromString (   $contact,
  $ignored = null 
)
static

Parses strings like "Evan <evan@elgg.org>" into name/email objects.

This is not very sophisticated and only used to provide a light BC effort.

Parameters
string$contacte.g. "Evan <evan@elgg.org>"
string$ignoredIgnored
Returns
Exceptions

Definition at line 89 of file Address.php.

static Elgg\Email\Address::getFormattedEmailAddress (   $email,
  $name = null 
)
static

Format an email address and name into a formatted email address.

eg "Some name <someone@example.com>"

Parameters
string$emailthe email address
string$namethe name
Returns
string
Exceptions

Definition at line 111 of file Address.php.

Elgg\Email\Address::setEmail (   $email)

Set the email address.

Parameters
string$emailthe new email address
Returns
void
Exceptions

Definition at line 26 of file Address.php.

Elgg\Email\Address::setName (   $name)

Set the name.

Parameters
string$namethe new name
Returns
void
Exceptions

Definition at line 54 of file Address.php.

Elgg\Email\Address::unsetName ( )

Clear the name from the email address.

Returns
void
Since
3.0

Definition at line 73 of file Address.php.


The documentation for this class was generated from the following file: