squirrelmail-webmail  1.4.22
About: SquirrelMail is a standards-based webmail package with strong MIME support, address books, and folder manipulation (written in PHP4).
  Fossies Dox: squirrelmail-webmail-1.4.22.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

AddressStructure Class Reference

Public Member Functions

 getAddress ($full=true, $encoded=false, $unconditionally_quote=FALSE)
 
 getEncodedAddress ($unconditionally_quote=FALSE)
 

Public Attributes

 $personal = ''
 
 $adl = ''
 
 $mailbox = ''
 
 $host = ''
 
 $group = ''
 

Detailed Description

Definition at line 23 of file AddressStructure.class.php.

Member Function Documentation

◆ getAddress()

AddressStructure::getAddress (   $full = true,
  $encoded = false,
  $unconditionally_quote = FALSE 
)

Return address information from mime headers.

Parameters
boolean$fullreturn 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
Returns
string

Definition at line 57 of file AddressStructure.class.php.

References $mailbox, $personal, and encodeHeader().

Referenced by getEncodedAddress().

◆ getEncodedAddress()

AddressStructure::getEncodedAddress (   $unconditionally_quote = FALSE)

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

Parameters
boolean$unconditionally_quote(since 1.4.21) 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
Returns
string
Since
1.4.0

Definition at line 101 of file AddressStructure.class.php.

References getAddress().

Member Data Documentation

◆ $adl

AddressStructure::$adl = ''

Definition at line 33 of file AddressStructure.class.php.

◆ $group

AddressStructure::$group = ''

Definition at line 48 of file AddressStructure.class.php.

◆ $host

AddressStructure::$host = ''

Definition at line 43 of file AddressStructure.class.php.

◆ $mailbox

AddressStructure::$mailbox = ''

Definition at line 38 of file AddressStructure.class.php.

Referenced by getAddress().

◆ $personal

AddressStructure::$personal = ''

Definition at line 28 of file AddressStructure.class.php.

Referenced by getAddress().


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