*
* This file contains functions needed to handle headers in mime messages.
*
- * @copyright © 2003-2006 The SquirrelMail Project Team
+ * @copyright 2003-2017 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
* @var mixed
*/
var $date = -1;
+ /**
+ * Original date header as fallback for unparsable dates
+ * @var mixed
+ */
+ var $date_unparsed = '';
/**
* Subject header
* @var string
*/
var $priority = 3;
/**
+ * Disposition notification for requesting message delivery notification (MDN)
* @var mixed
*/
var $dnt = '';
+ /**
+ * Delivery notification (DR)
+ * @var mixed
+ */
+ var $drnt = '';
/**
* @var mixed
*/
* @var mixed
*/
var $mlist = array();
+ /**
+ * SpamAssassin 'x-spam-status' header
+ * @var mixed
+ */
+ var $x_spam_status = array();
/**
* Extra header
* only needed for constructing headers in delivery class
$d = strtr($value, array(' ' => ' '));
$d = explode(' ', $d);
$this->date = getTimeStamp($d);
+ $this->date_unparsed = strtr($value,'<>',' ');
break;
case 'subject':
$this->subject = $value;
$this->references = $value;
break;
case 'x-confirm-reading-to':
- case 'return-receipt-to':
case 'disposition-notification-to':
$value = $this->stripComments($value);
$this->dnt = $this->parseAddress($value);
break;
+ case 'return-receipt-to':
+ $value = $this->stripComments($value);
+ $this->drnt = $this->parseAddress($value);
+ break;
case 'mime-version':
$value = $this->stripComments($value);
$value = str_replace(' ', '', $value);
$value = $this->stripComments($value);
$this->mlist('id', $value);
break;
+ case 'x-spam-status':
+ $this->x_spam_status = $this->parseSpamStatus($value);
+ break;
default:
break;
}
$sComment = trim(implode(' ',$aComment));
$sPersonal .= $sComment;
}
- $oAddr =& new AddressStructure();
+ $oAddr = new AddressStructure();
if ($sPersonal && substr($sPersonal,0,2) == '=?') {
$oAddr->personal = encodeHeader($sPersonal);
} else {
if ($sGroup) {
$aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
$oAddr = end($aAddress);
- if(!$oAddr || ((isset($oAddr)) && !$oAddr->mailbox && !$oAddr->personal)) {
+ if(!$oAddr || ((isset($oAddr)) && !strlen($oAddr->mailbox) && !$oAddr->personal)) {
$sEmail = $sGroup . ':;';
}
$aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
$aAddrBookAddress = $this->parseAddress($aAddr['email'],true);
} else {
$iPosAt = strpos($aAddr['email'], '@');
- $oAddr->mailbox = substr($aAddr['email'], 0, $iPosAt);
- $oAddr->host = substr($aAddr['email'], $iPosAt+1);
+ if ($iPosAt === FALSE) {
+ $oAddr->mailbox = $aAddr['email'];
+ $oAddr->host = FALSE;
+ } else {
+ $oAddr->mailbox = substr($aAddr['email'], 0, $iPosAt);
+ $oAddr->host = substr($aAddr['email'], $iPosAt+1);
+ }
if (isset($aAddr['name'])) {
$oAddr->personal = $aAddr['name'];
} else {
}
}
}
- if (!$grouplookup && !$oAddr->mailbox) {
+ if (!$grouplookup && !strlen($oAddr->mailbox)) {
$oAddr->mailbox = trim($sEmail);
- if ($sHost && $oAddr->mailbox) {
+ if ($sHost && strlen($oAddr->mailbox)) {
$oAddr->host = $sHost;
}
} else if (!$grouplookup && !$oAddr->host) {
- if ($sHost && $oAddr->mailbox) {
+ if ($sHost && strlen($oAddr->mailbox)) {
$oAddr->host = $sHost;
}
}
}
- if (!$aAddrBookAddress && $oAddr->mailbox) {
+ if (!$aAddrBookAddress && strlen($oAddr->mailbox)) {
$aProcessedAddress[] = $oAddr;
} else {
$aProcessedAddress = array_merge($aProcessedAddress,$aAddrBookAddress);
if ($ar) {
return $aProcessedAddress;
} else {
- return $aProcessedAddress[0];
+ if (isset($aProcessedAddress[0]))
+ return $aProcessedAddress[0];
+ else
+ return '';
}
}
* X-MS-Mail-Priority is not parsed because it always coincides
* with one of the other headers.
*
- * NOTE: this is actually a duplicate from the function in
- * functions/imap_messages. I'm not sure if it's ok here to call
+ * NOTE: this is actually a duplicate from the code in
+ * functions/imap_messages:parseFetch().
+ * I'm not sure if it's ok here to call
* that function?
* @param string $sValue literal priority name
* @return integer
*/
function parsePriority($sValue) {
// don't use function call inside array_shift.
- $aValue = split('/\w/',trim($sValue));
+ $aValue = preg_split('/\s/',trim($sValue));
$value = strtolower(array_shift($aValue));
if ( is_numeric($value) ) {
$value = substr($value,strlen($charset)+1);
/* FIXME: What's the status of charset decode with language information ????
* Maybe language information contains only ascii text and charset_decode()
- * only runs htmlspecialchars() on it. If it contains 8bit information, you
+ * only runs sm_encode_html_special_chars() on it. If it contains 8bit information, you
* get html encoded text in charset used by selected translation.
*/
$value = charset_decode($charset,$value);
$this->mlist[$field] = $res_a;
}
+ /**
+ * Parses the X-Spam-Status header
+ * @param string $value
+ */
+ function parseSpamStatus($value) {
+ // Header value looks like this:
+ // No, score=1.5 required=5.0 tests=MSGID_FROM_MTA_ID,NO_REAL_NAME,UPPERCASE_25_50 autolearn=disabled version=3.1.0-gr0
+
+ $spam_status = array();
+
+ if (preg_match ('/^(No|Yes),\s+score=(-?\d+\.\d+)\s+required=(-?\d+\.\d+)\s+tests=(.*?)\s+autolearn=(.*?)\s+version=(.+?)$/', $value, $matches)) {
+ // full header
+ $spam_status['bad_format'] = 0;
+ $spam_status['value'] = $matches[0];
+ // is_spam
+ if (isset($matches[1])
+ && strtolower($matches[1]) == 'yes') {
+ $spam_status['is_spam'] = true;
+ } else {
+ $spam_status['is_spam'] = false;
+ }
+
+ // score
+ $spam_status['score'] = $matches[2];
+
+ // required
+ $spam_status['required'] = $matches[3];
+
+ // tests
+ $tests = array();
+ $tests = explode(',', $matches[4]);
+ foreach ($tests as $test) {
+ $spam_status['tests'][] = trim($test);
+ }
+
+ // autolearn
+ $spam_status['autolearn'] = $matches[5];
+
+ // version
+ $spam_status['version'] = $matches[6];
+ } else {
+ $spam_status['bad_format'] = 1;
+ $spam_status['value'] = $value;
+ }
+ return $spam_status;
+ }
+
/**
* function to get the address strings out of the header.
* example1: header->getAddr_s('to').
* @param mixed $arr string or array of strings
* @param string $separator
* @param boolean $encoded (since 1.4.0) return encoded or plain text addresses
+ * @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 getAddr_s($arr, $separator = ',',$encoded=false) {
+ function getAddr_s($arr, $separator = ', ', $encoded=false, $unconditionally_quote=FALSE) {
$s = '';
if (is_array($arr)) {
foreach($arr as $arg) {
- if ($this->getAddr_s($arg, $separator, $encoded)) {
+ if ($this->getAddr_s($arg, $separator, $encoded, $unconditionally_quote)) {
$s .= $separator;
}
}
foreach ($addr as $addr_o) {
if (is_object($addr_o)) {
if ($encoded) {
- $s .= $addr_o->getEncodedAddress() . $separator;
+ $s .= $addr_o->getEncodedAddress($unconditionally_quote) . $separator;
} else {
- $s .= $addr_o->getAddress() . $separator;
+ $s .= $addr_o->getAddress(TRUE, FALSE, $unconditionally_quote) . $separator;
}
}
}
} else {
if (is_object($addr)) {
if ($encoded) {
- $s .= $addr->getEncodedAddress();
+ $s .= $addr->getEncodedAddress($unconditionally_quote);
} else {
- $s .= $addr->getAddress();
+ $s .= $addr->getAddress(TRUE, FALSE, $unconditionally_quote);
}
}
}
}
/**
- * @param mixed $address array or string
- * @param boolean $recurs
- * @return mixed array, boolean
+//FIXME: This needs some documentation (inside the function too)! Don't code w/out comments!
+ * Looking at the code years after it was written,
+ * this is my (Paul) best guess as to what this
+ * function does (note that docs previously claimed
+ * that this function returns boolean or an array,
+ * but it no longer appears to return an array - an
+ * integer instead):
+ *
+ * Inspects the TO and CC headers of the message
+ * represented by this object, looking for the
+ * address(es) given by $address
+ *
+ * If $address is a string:
+ * Serves as a test (returns boolean) as to
+ * whether or not the given address is found
+ * anywhere in the TO or CC headers
+ *
+ * If $address is an array:
+ * Looks through this list of addresses and
+ * returns the array index (an integer even
+ * if the array is given with keys of a
+ * different type) of the first matching
+ * $address found in this message's
+ * TO or CC headers, unless there is an exact
+ * match (meaning that the "personal
+ * information" in addition to the email
+ * address also matches), in which case that
+ * index (the first one found) is returned
+ *
+ * @param mixed $address Address(es) to search for in this
+ * message's TO and CC headers - please
+ * see above how the format of this
+ * argument affects the return value
+ * of this function
+ * @param boolean $recurs FOR INTERNAL USE ONLY
+ *
+ * @return mixed Boolean when $address is a scalar,
+ * indicating whether or not the address
+ * was found in the TO or CC headers.
+ * An integer when $address is an array,
+ * containing the index of the value in
+ * that array that was found in the TO
+ * or CC headers, or boolean FALSE if
+ * there were no matches at all
+ *
* @since 1.3.2
*/
function findAddress($address, $recurs = false) {
$i=0;
foreach($address as $argument) {
$match = $this->findAddress($argument, true);
- if ($match[1]) {
+ if ($match[1]) { // this indicates when the personal information matched
return $i;
} else {
- if (count($match[0]) && !$result) {
+ if (count($match[0]) && $result === FALSE) {
$result = $i;
}
}
}
} else {
if (!is_array($this->cc)) $this->cc = array();
+ if (!is_array($this->to)) $this->to = array();
$srch_addr = $this->parseAddress($address);
$results = array();
foreach ($this->to as $to) {
- if ($to->host == $srch_addr->host) {
- if ($to->mailbox == $srch_addr->mailbox) {
+ if (strtolower($to->host) == strtolower($srch_addr->host)) {
+ if (strtolower($to->mailbox) == strtolower($srch_addr->mailbox)) {
$results[] = $srch_addr;
- if ($to->personal == $srch_addr->personal) {
+ if (strtolower($to->personal) == strtolower($srch_addr->personal)) {
if ($recurs) {
return array($results, true);
} else {
}
}
foreach ($this->cc as $cc) {
- if ($cc->host == $srch_addr->host) {
- if ($cc->mailbox == $srch_addr->mailbox) {
+ if (strtolower($cc->host) == strtolower($srch_addr->host)) {
+ if (strtolower($cc->mailbox) == strtolower($srch_addr->mailbox)) {
$results[] = $srch_addr;
- if ($cc->personal == $srch_addr->personal) {
+ if (strtolower($cc->personal) == strtolower($srch_addr->personal)) {
if ($recurs) {
return array($results, true);
} else {
}
if ($recurs) {
return array($results, false);
- } elseif (count($result)) {
+ } elseif (count($results)) {
return true;
} else {
return false;
return $this->content_type->properties;
}
}
-
-?>
projects / squirrelmail.git / blobdiff