Class AddressStructure

Description

Class used to work with email address headers

  • since: 1.3.2

Located in /class/mime/AddressStructure.class.php (line 23)


	
			
Variable Summary
string $adl
string $group
string $host
string $mailbox
string $personal
Method Summary
string getAddress ([boolean $full = true], [boolean $encoded = false], [boolean $unconditionally_quote = FALSE])
string getEmail ()
string getEncodedAddress ([boolean $unconditionally_quote = FALSE])
Variables
string $adl = '' (line 33)
  • todo: check use of this variable. var is not used in class.
string $group = '' (line 48)
  • todo: check use of this variable. var is not used in class.
string $host = '' (line 43)

Server address.

string $mailbox = '' (line 38)

Mailbox name.

string $personal = '' (line 28)

Personal information

Methods
getAddress (line 58)

Return address information from mime headers.

string getAddress ([boolean $full = true], [boolean $encoded = false], [boolean $unconditionally_quote = FALSE])
  • boolean $full: return full address (true) or only personal if it exists, otherwise email (false)
  • boolean $encoded: (since 1.4.0) return rfc2047 encoded address (true) or plain text (false).
  • boolean $unconditionally_quote: (since 1.4.21/1.5.2) when TRUE, always quote the personal part, whether or not it is encoded, otherwise quoting is only added if the personal part is not encoded
getEmail (line 111)

Return just the email portion of this address

  • since: 1.5.2
string getEmail ()
getEncodedAddress (line 102)

Shorter version of getAddress() function Returns full encoded address.

  • since: 1.4.0
string getEncodedAddress ([boolean $unconditionally_quote = FALSE])
  • boolean $unconditionally_quote: (since 1.4.21/1.5.2) when TRUE, always quote the personal part, whether or not it is encoded, otherwise quoting is only added if the personal part is not encoded

Documentation generated on Fri, 31 Oct 2014 04:17:14 +0100 by phpDocumentor 1.4.3