Source for file AddressStructure.class.php

Documentation is available at AddressStructure.class.php

  1. <?php
  2.  
  3. /**
  4.  * AddressStructure.class.php
  5.  *
  6.  * This file contains functions needed to extract email address headers from
  7.  * mime messages.
  8.  *
  9.  * @copyright 2003-2014 The SquirrelMail Project Team
  10.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11.  * @version $Id: AddressStructure.class.php 14422 2014-01-01 20:59:43Z pdontthink $
  12.  * @package squirrelmail
  13.  * @subpackage mime
  14.  * @since 1.3.2
  15.  */
  16.  
  17. /**
  18.  * Class used to work with email address headers
  19.  * @package squirrelmail
  20.  * @subpackage mime
  21.  * @since 1.3.2
  22.  */
  23.     /**
  24.      * Personal information
  25.      * @var string 
  26.      */
  27.     var $personal = '';
  28.     /**
  29.      * @todo check use of this variable. var is not used in class.
  30.      * @var string 
  31.      */
  32.     var $adl      = '';
  33.     /**
  34.      * Mailbox name.
  35.      * @var string 
  36.      */
  37.     var $mailbox  = '';
  38.     /**
  39.      * Server address.
  40.      * @var string 
  41.      */
  42.     var $host     = '';
  43.     /**
  44.      * @todo check use of this variable. var is not used in class.
  45.      * @var string 
  46.      */
  47.     var $group    = '';
  48.  
  49.     /**
  50.      * Return address information from mime headers.
  51.      * @param boolean $full return full address (true) or only personal if it exists, otherwise email (false)
  52.      * @param boolean $encoded (since 1.4.0) return rfc2047 encoded address (true) or plain text (false).
  53.      * @param 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
  54.      * @return string 
  55.      */
  56.     function getAddress($full true$encoded false$unconditionally_quote FALSE{
  57.         $result '';
  58.         if (is_object($this)) {
  59.             $email ($this->host ? $this->mailbox.'@'.$this->host
  60.                                   : $this->mailbox);
  61.             $personal trim($this->personal);
  62.             $is_encoded false;
  63.             // FIXME: I don't think the U modifier below does anything at all
  64.             if (preg_match('/(=\?([^?]*)\?(Q|B)\?([^?]*)\?=)(.*)/Ui',$personal,$reg)) {
  65.                 $is_encoded true;
  66.             }
  67.             if ($personal{
  68.                 if ($encoded && !$is_encoded{
  69.                     $personal_encoded encodeHeader('"' $personal '"');
  70.                     if ($personal !== $personal_encoded{
  71.                         $personal $personal_encoded;
  72.                     else {
  73.                         //FIXME: this probably adds quotes around an encoded string which itself is already quoted
  74.                         $personal '"'.$this->personal.'"';
  75.                     }
  76.                 else {
  77.                     if (!$is_encoded || $unconditionally_quote{
  78.                         $personal '"'.$this->personal.'"';
  79.                     }
  80.                 }
  81.                 $addr ($email $personal ' <' .$email.'>'
  82.                         : $this->personal);
  83.                 $best_dpl $this->personal;
  84.             else {
  85.                 $addr $email;
  86.                 $best_dpl $email;
  87.             }
  88.             $result ($full $addr $best_dpl);
  89.         }
  90.         return $result;
  91.     }
  92.  
  93.     /**
  94.      * Shorter version of getAddress() function
  95.      * Returns full encoded address.
  96.      * @param 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
  97.      * @return string 
  98.      * @since 1.4.0
  99.      */
  100.     function getEncodedAddress($unconditionally_quote=FALSE{
  101.         return $this->getAddress(truetrue$unconditionally_quote);
  102.     }
  103. }

Documentation generated on Mon, 22 Sep 2014 04:20:22 +0200 by phpDocumentor 1.4.3