Class AddressStructure

Description

Class used to work with email address headers

Located in /nasmail/class/mime/AddressStructure.class.php (line 22)


	
			
Variable Summary
 string $adl
 string $group
 string $host
 string $mailbox
 string $personal
Method Summary
 string getAddress ([boolean $full = true], [boolean $encoded = false])
 string getEncodedAddress ()
Variables
string $adl = '' (line 37)

SMTP at-domain-list (source route)

Second parameter in IMAP ENVELOPE address structures.

string $group = '' (line 60)

Group.

IMAP rfc provides only obscure comments about some special envelope structure.

  • todo: check rfc2822 and test group in address specification
string $host = '' (line 52)

Server address.

Domain part in address specification

string $mailbox = '' (line 45)

Mailbox name.

local part in address specification

  • todo: test quoted string in mailbox name
string $personal = '' (line 30)

Personal information

Scripts should store name in plain text. Use of MIME encoded personal name in this object is a bug.

Methods
getAddress (line 68)

Return address information from mime headers.

string getAddress ([boolean $full = true], [boolean $encoded = false])
  • boolean $full: return full address (true) or only personal if it exists, otherwise email (false)
  • boolean $encoded: return rfc2047 encoded address (true) or plain text (false).
getEncodedAddress (line 119)

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

string getEncodedAddress ()

Documentation generated on Sun, 22 Nov 2009 17:36:14 +0200 by phpDocumentor 1.4.3