/**
* AddressStructure.class.php
*
- * Copyright (c) 2003-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- * This contains functions needed to handle mime messages.
+ * This file contains functions needed to extract email address headers from
+ * mime messages.
*
+ * @copyright 2003-2017 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.2
*/
/**
- * Undocumented class
+ * Class used to work with email address headers
* @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.2
*/
class AddressStructure {
- var $personal = '',
- $adl = '',
- $mailbox = '',
- $host = '',
- $group = '';
+ /**
+ * Personal information
+ * @var string
+ */
+ var $personal = '';
+ /**
+ * @todo check use of this variable. var is not used in class.
+ * @var string
+ */
+ var $adl = '';
+ /**
+ * Mailbox name.
+ * @var string
+ */
+ var $mailbox = '';
+ /**
+ * Server address.
+ * @var string
+ */
+ var $host = '';
+ /**
+ * @todo check use of this variable. var is not used in class.
+ * @var string
+ */
+ var $group = '';
- function getAddress($full = true, $encoded = false) {
+ /**
+ * Return address information from mime headers.
+ * @param boolean $full return full address (true) or only personal if it exists, otherwise email (false)
+ * @param boolean $encoded (since 1.4.0) return rfc2047 encoded address (true) or plain text (false).
+ * @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
+ *
+ * @return string
+ */
+ function getAddress($full = true, $encoded = false, $unconditionally_quote = FALSE) {
$result = '';
if (is_object($this)) {
$email = ($this->host ? $this->mailbox.'@'.$this->host
: $this->mailbox);
$personal = trim($this->personal);
$is_encoded = false;
- if (preg_match('/(=\?([^?]*)\?(Q|B)\?([^?]*)\?=)(.*)/Ui',$personal,$reg)) {
+ if (preg_match('/(=\?([^?]*)\?(Q|B)\?([^?]*)\?=)(.*)/i',$personal,$reg)) {
$is_encoded = true;
}
if ($personal) {
if ($encoded && !$is_encoded) {
- $personal_encoded = encodeHeader($personal);
+ $personal_encoded = encodeHeader('"' . $personal . '"');
if ($personal !== $personal_encoded) {
$personal = $personal_encoded;
} else {
- $personal = '"'.$this->personal.'"';
+ //FIXME: this probably adds quotes around an encoded string which itself is already quoted
+ $personal = '"' . $this->personal . '"';
}
} else {
- if (!$is_encoded) {
- $personal = '"'.$this->personal.'"';
+ if (!$is_encoded || $unconditionally_quote) {
+ $personal = '"' . $this->personal . '"';
}
}
$addr = ($email ? $personal . ' <' .$email.'>'
return $result;
}
- function getEncodedAddress() {
- return $this->getAddress(true, true);
+ /**
+ * Shorter version of getAddress() function
+ * Returns full encoded address.
+ * @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
+ *
+ * @return string
+ * @since 1.4.0
+ */
+ function getEncodedAddress($unconditionally_quote=FALSE) {
+ return $this->getAddress(true, true, $unconditionally_quote);
+ }
+
+ /**
+ * Return just the email portion of this address
+ * @return string
+ * @since 1.5.2
+ */
+ function getEmail () {
+ $r = '';
+ if (is_object($this)) {
+ $r = $this->host ? $this->mailbox.'@'.$this->host : $this->mailbox;
+ }
+ return $r;
}
}
-
-?>
\ No newline at end of file