Don't start message ID with a dot when no remote port is available
[squirrelmail.git] / class / mime / Rfc822Header.class.php
1 <?php
2
3 /**
4 * Rfc822Header.class.php
5 *
6 * This file contains functions needed to handle headers in mime messages.
7 *
8 * @copyright &copy; 2003-2007 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
10 * @version $Id$
11 * @package squirrelmail
12 * @subpackage mime
13 * @since 1.3.2
14 */
15
16 /**
17 * MIME header class
18 * input: header_string or array
19 * You must call parseHeader() function after creating object in order to fill object's
20 * parameters.
21 * @todo FIXME: there is no constructor function and class should ignore all input args.
22 * @package squirrelmail
23 * @subpackage mime
24 * @since 1.3.0
25 */
26 class Rfc822Header {
27 /**
28 * Date header
29 * @var mixed
30 */
31 var $date = -1;
32 /**
33 * Original date header as fallback for unparsable dates
34 * @var mixed
35 */
36 var $date_unparsed = '';
37 /**
38 * Subject header
39 * @var string
40 */
41 var $subject = '';
42 /**
43 * From header
44 * @var array
45 */
46 var $from = array();
47 /**
48 * @var mixed
49 */
50 var $sender = '';
51 /**
52 * Reply-To header
53 * @var array
54 */
55 var $reply_to = array();
56 /**
57 * Mail-Followup-To header
58 * @var array
59 */
60 var $mail_followup_to = array();
61 /**
62 * To header
63 * @var array
64 */
65 var $to = array();
66 /**
67 * Cc header
68 * @var array
69 */
70 var $cc = array();
71 /**
72 * Bcc header
73 * @var array
74 */
75 var $bcc = array();
76 /**
77 * In-reply-to header
78 * @var string
79 */
80 var $in_reply_to = '';
81 /**
82 * Message-ID header
83 * @var string
84 */
85 var $message_id = '';
86 /**
87 * References header
88 * @var string
89 */
90 var $references = '';
91 /**
92 * @var mixed
93 */
94 var $mime = false;
95 /**
96 * Content Type object
97 * @var object
98 */
99 var $content_type = '';
100 /**
101 * @var mixed
102 */
103 var $disposition = '';
104 /**
105 * X-Mailer header
106 * @var string
107 */
108 var $xmailer = '';
109 /**
110 * Priority header
111 * @var integer
112 */
113 var $priority = 3;
114 /**
115 * Disposition notification for requesting message delivery notification (MDN)
116 * @var mixed
117 */
118 var $dnt = '';
119 /**
120 * Delivery notification (DR)
121 * @var mixed
122 */
123 var $drnt = '';
124 /**
125 * @var mixed
126 */
127 var $encoding = '';
128 /**
129 * @var mixed
130 */
131 var $content_id = '';
132 /**
133 * @var mixed
134 */
135 var $content_desc = '';
136 /**
137 * @var mixed
138 */
139 var $mlist = array();
140 /**
141 * SpamAssassin 'x-spam-status' header
142 * @var mixed
143 */
144 var $x_spam_status = array();
145 /**
146 * Extra header
147 * only needed for constructing headers in delivery class
148 * @var array
149 */
150 var $more_headers = array();
151
152 /**
153 * @param mixed $hdr string or array with message headers
154 */
155 function parseHeader($hdr) {
156 if (is_array($hdr)) {
157 $hdr = implode('', $hdr);
158 }
159 /* First we replace \r\n by \n and unfold the header */
160 /* FIXME: unfolding header with multiple spaces "\n( +)" */
161 $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $hdr));
162
163 /* Now we can make a new header array with */
164 /* each element representing a headerline */
165 $hdr = explode("\n" , $hdr);
166 foreach ($hdr as $line) {
167 $pos = strpos($line, ':');
168 if ($pos > 0) {
169 $field = substr($line, 0, $pos);
170 if (!strstr($field,' ')) { /* valid field */
171 $value = trim(substr($line, $pos+1));
172 $this->parseField($field, $value);
173 }
174 }
175 }
176 if (!is_object($this->content_type)) {
177 $this->parseContentType('text/plain; charset=us-ascii');
178 }
179 }
180
181 /**
182 * @param string $value
183 * @return string
184 */
185 function stripComments($value) {
186 $result = '';
187 $cnt = strlen($value);
188 for ($i = 0; $i < $cnt; ++$i) {
189 switch ($value{$i}) {
190 case '"':
191 $result .= '"';
192 while ((++$i < $cnt) && ($value{$i} != '"')) {
193 if ($value{$i} == '\\') {
194 $result .= '\\';
195 ++$i;
196 }
197 $result .= $value{$i};
198 }
199 if($i < $cnt) {
200 $result .= $value{$i};
201 }
202 break;
203 case '(':
204 $depth = 1;
205 while (($depth > 0) && (++$i < $cnt)) {
206 switch($value{$i}) {
207 case '\\':
208 ++$i;
209 break;
210 case '(':
211 ++$depth;
212 break;
213 case ')':
214 --$depth;
215 break;
216 default:
217 break;
218 }
219 }
220 break;
221 default:
222 $result .= $value{$i};
223 break;
224 }
225 }
226 return $result;
227 }
228
229 /**
230 * Parse header field according to field type
231 * @param string $field field name
232 * @param string $value field value
233 */
234 function parseField($field, $value) {
235 $field = strtolower($field);
236 switch($field) {
237 case 'date':
238 $value = $this->stripComments($value);
239 $d = strtr($value, array(' ' => ' '));
240 $d = explode(' ', $d);
241 $this->date = getTimeStamp($d);
242 $this->date_unparsed = strtr($value,'<>',' ');
243 break;
244 case 'subject':
245 $this->subject = $value;
246 break;
247 case 'from':
248 $this->from = $this->parseAddress($value,true);
249 break;
250 case 'sender':
251 $this->sender = $this->parseAddress($value);
252 break;
253 case 'reply-to':
254 $this->reply_to = $this->parseAddress($value, true);
255 break;
256 case 'mail-followup-to':
257 $this->mail_followup_to = $this->parseAddress($value, true);
258 break;
259 case 'to':
260 $this->to = $this->parseAddress($value, true);
261 break;
262 case 'cc':
263 $this->cc = $this->parseAddress($value, true);
264 break;
265 case 'bcc':
266 $this->bcc = $this->parseAddress($value, true);
267 break;
268 case 'in-reply-to':
269 $this->in_reply_to = $value;
270 break;
271 case 'message-id':
272 $value = $this->stripComments($value);
273 $this->message_id = $value;
274 break;
275 case 'references':
276 $value = $this->stripComments($value);
277 $this->references = $value;
278 break;
279 case 'x-confirm-reading-to':
280 case 'disposition-notification-to':
281 $value = $this->stripComments($value);
282 $this->dnt = $this->parseAddress($value);
283 break;
284 case 'return-receipt-to':
285 $value = $this->stripComments($value);
286 $this->drnt = $this->parseAddress($value);
287 break;
288 case 'mime-version':
289 $value = $this->stripComments($value);
290 $value = str_replace(' ', '', $value);
291 $this->mime = ($value == '1.0' ? true : $this->mime);
292 break;
293 case 'content-type':
294 $value = $this->stripComments($value);
295 $this->parseContentType($value);
296 break;
297 case 'content-disposition':
298 $value = $this->stripComments($value);
299 $this->parseDisposition($value);
300 break;
301 case 'content-transfer-encoding':
302 $this->encoding = $value;
303 break;
304 case 'content-description':
305 $this->content_desc = $value;
306 break;
307 case 'content-id':
308 $value = $this->stripComments($value);
309 $this->content_id = $value;
310 break;
311 case 'user-agent':
312 case 'x-mailer':
313 $this->xmailer = $value;
314 break;
315 case 'x-priority':
316 case 'importance':
317 case 'priority':
318 $this->priority = $this->parsePriority($value);
319 break;
320 case 'list-post':
321 $value = $this->stripComments($value);
322 $this->mlist('post', $value);
323 break;
324 case 'list-reply':
325 $value = $this->stripComments($value);
326 $this->mlist('reply', $value);
327 break;
328 case 'list-subscribe':
329 $value = $this->stripComments($value);
330 $this->mlist('subscribe', $value);
331 break;
332 case 'list-unsubscribe':
333 $value = $this->stripComments($value);
334 $this->mlist('unsubscribe', $value);
335 break;
336 case 'list-archive':
337 $value = $this->stripComments($value);
338 $this->mlist('archive', $value);
339 break;
340 case 'list-owner':
341 $value = $this->stripComments($value);
342 $this->mlist('owner', $value);
343 break;
344 case 'list-help':
345 $value = $this->stripComments($value);
346 $this->mlist('help', $value);
347 break;
348 case 'list-id':
349 $value = $this->stripComments($value);
350 $this->mlist('id', $value);
351 break;
352 case 'x-spam-status':
353 $this->x_spam_status = $this->parseSpamStatus($value);
354 break;
355 default:
356 break;
357 }
358 }
359
360 /**
361 * @param string $address
362 * @return array
363 */
364 function getAddressTokens($address) {
365 $aTokens = array();
366 $aSpecials = array('(' ,'<' ,',' ,';' ,':');
367 $aReplace = array(' (',' <',' ,',' ;',' :');
368 $address = str_replace($aSpecials,$aReplace,$address);
369 $iCnt = strlen($address);
370 $i = 0;
371 while ($i < $iCnt) {
372 $cChar = $address{$i};
373 switch($cChar)
374 {
375 case '<':
376 $iEnd = strpos($address,'>',$i+1);
377 if (!$iEnd) {
378 $sToken = substr($address,$i);
379 $i = $iCnt;
380 } else {
381 $sToken = substr($address,$i,$iEnd - $i +1);
382 $i = $iEnd;
383 }
384 $sToken = str_replace($aReplace, $aSpecials,$sToken);
385 if ($sToken) $aTokens[] = $sToken;
386 break;
387 case '"':
388 $iEnd = strpos($address,$cChar,$i+1);
389 if ($iEnd) {
390 // skip escaped quotes
391 $prev_char = $address{$iEnd-1};
392 while ($prev_char === '\\' && substr($address,$iEnd-2,2) !== '\\\\') {
393 $iEnd = strpos($address,$cChar,$iEnd+1);
394 if ($iEnd) {
395 $prev_char = $address{$iEnd-1};
396 } else {
397 $prev_char = false;
398 }
399 }
400 }
401 if (!$iEnd) {
402 $sToken = substr($address,$i);
403 $i = $iCnt;
404 } else {
405 // also remove the surrounding quotes
406 $sToken = substr($address,$i+1,$iEnd - $i -1);
407 $i = $iEnd;
408 }
409 $sToken = str_replace($aReplace, $aSpecials,$sToken);
410 if ($sToken) $aTokens[] = $sToken;
411 break;
412 case '(':
413 array_pop($aTokens); //remove inserted space
414 $iEnd = strpos($address,')',$i);
415 if (!$iEnd) {
416 $sToken = substr($address,$i);
417 $i = $iCnt;
418 } else {
419 $iDepth = 1;
420 $iComment = $i;
421 while (($iDepth > 0) && (++$iComment < $iCnt)) {
422 $cCharComment = $address{$iComment};
423 switch($cCharComment) {
424 case '\\':
425 ++$iComment;
426 break;
427 case '(':
428 ++$iDepth;
429 break;
430 case ')':
431 --$iDepth;
432 break;
433 default:
434 break;
435 }
436 }
437 if ($iDepth == 0) {
438 $sToken = substr($address,$i,$iComment - $i +1);
439 $i = $iComment;
440 } else {
441 $sToken = substr($address,$i,$iEnd - $i + 1);
442 $i = $iEnd;
443 }
444 }
445 // check the next token in case comments appear in the middle of email addresses
446 $prevToken = end($aTokens);
447 if (!in_array($prevToken,$aSpecials,true)) {
448 if ($i+1<strlen($address) && !in_array($address{$i+1},$aSpecials,true)) {
449 $iEnd = strpos($address,' ',$i+1);
450 if ($iEnd) {
451 $sNextToken = trim(substr($address,$i+1,$iEnd - $i -1));
452 $i = $iEnd-1;
453 } else {
454 $sNextToken = trim(substr($address,$i+1));
455 $i = $iCnt;
456 }
457 // remove the token
458 array_pop($aTokens);
459 // create token and add it again
460 $sNewToken = $prevToken . $sNextToken;
461 if($sNewToken) $aTokens[] = $sNewToken;
462 }
463 }
464 $sToken = str_replace($aReplace, $aSpecials,$sToken);
465 if ($sToken) $aTokens[] = $sToken;
466 break;
467 case ',':
468 case ':':
469 case ';':
470 case ' ':
471 $aTokens[] = $cChar;
472 break;
473 default:
474 $iEnd = strpos($address,' ',$i+1);
475 if ($iEnd) {
476 $sToken = trim(substr($address,$i,$iEnd - $i));
477 $i = $iEnd-1;
478 } else {
479 $sToken = trim(substr($address,$i));
480 $i = $iCnt;
481 }
482 if ($sToken) $aTokens[] = $sToken;
483 }
484 ++$i;
485 }
486 return $aTokens;
487 }
488
489 /**
490 * @param array $aStack
491 * @param array $aComment
492 * @param string $sEmail
493 * @param string $sGroup
494 * @return object AddressStructure object
495 */
496 function createAddressObject(&$aStack,&$aComment,&$sEmail,$sGroup='') {
497 //$aStack=explode(' ',implode('',$aStack));
498 if (!$sEmail) {
499 while (count($aStack) && !$sEmail) {
500 $sEmail = trim(array_pop($aStack));
501 }
502 }
503 if (count($aStack)) {
504 $sPersonal = trim(implode('',$aStack));
505 } else {
506 $sPersonal = '';
507 }
508 if (!$sPersonal && count($aComment)) {
509 $sComment = trim(implode(' ',$aComment));
510 $sPersonal .= $sComment;
511 }
512 $oAddr =& new AddressStructure();
513 if ($sPersonal && substr($sPersonal,0,2) == '=?') {
514 $oAddr->personal = encodeHeader($sPersonal);
515 } else {
516 $oAddr->personal = $sPersonal;
517 }
518 // $oAddr->group = $sGroup;
519 $iPosAt = strpos($sEmail,'@');
520 if ($iPosAt) {
521 $oAddr->mailbox = substr($sEmail, 0, $iPosAt);
522 $oAddr->host = substr($sEmail, $iPosAt+1);
523 } else {
524 $oAddr->mailbox = $sEmail;
525 $oAddr->host = false;
526 }
527 $sEmail = '';
528 $aStack = $aComment = array();
529 return $oAddr;
530 }
531
532 /**
533 * recursive function for parsing address strings and storing them in an address stucture object.
534 * personal name: encoded: =?charset?Q|B?string?=
535 * quoted: "string"
536 * normal: string
537 * email : <mailbox@host>
538 * : mailbox@host
539 * This function is also used for validating addresses returned from compose
540 * That's also the reason that the function became a little bit huge
541 * @param string $address
542 * @param boolean $ar return array instead of only the first element
543 * @param array $addr_ar (obsolete) array with parsed addresses
544 * @param string $group (obsolete)
545 * @param string $host default domainname in case of addresses without a domainname
546 * @param string $lookup (since) callback function for lookup of address strings which are probably nicks (without @)
547 * @return mixed array with AddressStructure objects or only one address_structure object.
548 */
549 function parseAddress($address,$ar=false,$aAddress=array(),$sGroup='',$sHost='',$lookup=false) {
550 $aTokens = $this->getAddressTokens($address);
551 $sPersonal = $sEmail = $sGroup = '';
552 $aStack = $aComment = array();
553 foreach ($aTokens as $sToken) {
554 $cChar = $sToken{0};
555 switch ($cChar)
556 {
557 case '=':
558 case '"':
559 case ' ':
560 $aStack[] = $sToken;
561 break;
562 case '(':
563 $aComment[] = substr($sToken,1,-1);
564 break;
565 case ';':
566 if ($sGroup) {
567 $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
568 $oAddr = end($aAddress);
569 if(!$oAddr || ((isset($oAddr)) && !strlen($oAddr->mailbox) && !$oAddr->personal)) {
570 $sEmail = $sGroup . ':;';
571 }
572 $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
573 $sGroup = '';
574 $aStack = $aComment = array();
575 break;
576 }
577 case ',':
578 $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail,$sGroup);
579 break;
580 case ':':
581 $sGroup = trim(implode(' ',$aStack));
582 $sGroup = preg_replace('/\s+/',' ',$sGroup);
583 $aStack = array();
584 break;
585 case '<':
586 $sEmail = trim(substr($sToken,1,-1));
587 break;
588 case '>':
589 /* skip */
590 break;
591 default: $aStack[] = $sToken; break;
592 }
593 }
594 /* now do the action again for the last address */
595 $aAddress[] = $this->createAddressObject($aStack,$aComment,$sEmail);
596 /* try to lookup the addresses in case of invalid email addresses */
597 $aProcessedAddress = array();
598 foreach ($aAddress as $oAddr) {
599 $aAddrBookAddress = array();
600 if (!$oAddr->host) {
601 $grouplookup = false;
602 if ($lookup) {
603 $aAddr = call_user_func_array($lookup,array($oAddr->mailbox));
604 if (isset($aAddr['email'])) {
605 if (strpos($aAddr['email'],',')) {
606 $grouplookup = true;
607 $aAddrBookAddress = $this->parseAddress($aAddr['email'],true);
608 } else {
609 $iPosAt = strpos($aAddr['email'], '@');
610 $oAddr->mailbox = substr($aAddr['email'], 0, $iPosAt);
611 $oAddr->host = substr($aAddr['email'], $iPosAt+1);
612 if (isset($aAddr['name'])) {
613 $oAddr->personal = $aAddr['name'];
614 } else {
615 $oAddr->personal = encodeHeader($sPersonal);
616 }
617 }
618 }
619 }
620 if (!$grouplookup && !strlen($oAddr->mailbox)) {
621 $oAddr->mailbox = trim($sEmail);
622 if ($sHost && strlen($oAddr->mailbox)) {
623 $oAddr->host = $sHost;
624 }
625 } else if (!$grouplookup && !$oAddr->host) {
626 if ($sHost && strlen($oAddr->mailbox)) {
627 $oAddr->host = $sHost;
628 }
629 }
630 }
631 if (!$aAddrBookAddress && strlen($oAddr->mailbox)) {
632 $aProcessedAddress[] = $oAddr;
633 } else {
634 $aProcessedAddress = array_merge($aProcessedAddress,$aAddrBookAddress);
635 }
636 }
637 if ($ar) {
638 return $aProcessedAddress;
639 } else {
640 return $aProcessedAddress[0];
641 }
642 }
643
644 /**
645 * Normalise the different Priority headers into a uniform value,
646 * namely that of the X-Priority header (1, 3, 5). Supports:
647 * Priority, X-Priority, Importance.
648 * X-MS-Mail-Priority is not parsed because it always coincides
649 * with one of the other headers.
650 *
651 * NOTE: this is actually a duplicate from the code in
652 * functions/imap_messages:parseFetch().
653 * I'm not sure if it's ok here to call
654 * that function?
655 * @param string $sValue literal priority name
656 * @return integer
657 */
658 function parsePriority($sValue) {
659 // don't use function call inside array_shift.
660 $aValue = preg_split('/\s/',trim($sValue));
661 $value = strtolower(array_shift($aValue));
662
663 if ( is_numeric($value) ) {
664 return $value;
665 }
666 if ( $value == 'urgent' || $value == 'high' ) {
667 return 1;
668 } elseif ( $value == 'non-urgent' || $value == 'low' ) {
669 return 5;
670 }
671 // default is normal priority
672 return 3;
673 }
674
675 /**
676 * @param string $value content type header
677 */
678 function parseContentType($value) {
679 $pos = strpos($value, ';');
680 $props = '';
681 if ($pos > 0) {
682 $type = trim(substr($value, 0, $pos));
683 $props = trim(substr($value, $pos+1));
684 } else {
685 $type = $value;
686 }
687 $content_type = new ContentType($type);
688 if ($props) {
689 $properties = $this->parseProperties($props);
690 if (!isset($properties['charset'])) {
691 $properties['charset'] = 'us-ascii';
692 }
693 $content_type->properties = $this->parseProperties($props);
694 }
695 $this->content_type = $content_type;
696 }
697
698 /**
699 * RFC2184
700 * @param array $aParameters
701 * @return array
702 */
703 function processParameters($aParameters) {
704 $aResults = array();
705 $aCharset = array();
706 // handle multiline parameters
707 foreach($aParameters as $key => $value) {
708 if ($iPos = strpos($key,'*')) {
709 $sKey = substr($key,0,$iPos);
710 if (!isset($aResults[$sKey])) {
711 $aResults[$sKey] = $value;
712 if (substr($key,-1) == '*') { // parameter contains language/charset info
713 $aCharset[] = $sKey;
714 }
715 } else {
716 $aResults[$sKey] .= $value;
717 }
718 } else {
719 $aResults[$key] = $value;
720 }
721 }
722 foreach ($aCharset as $key) {
723 $value = $aResults[$key];
724 // extract the charset & language
725 $charset = substr($value,0,strpos($value,"'"));
726 $value = substr($value,strlen($charset)+1);
727 $language = substr($value,0,strpos($value,"'"));
728 $value = substr($value,strlen($charset)+1);
729 /* FIXME: What's the status of charset decode with language information ????
730 * Maybe language information contains only ascii text and charset_decode()
731 * only runs htmlspecialchars() on it. If it contains 8bit information, you
732 * get html encoded text in charset used by selected translation.
733 */
734 $value = charset_decode($charset,$value);
735 $aResults[$key] = $value;
736 }
737 return $aResults;
738 }
739
740 /**
741 * @param string $value
742 * @return array
743 */
744 function parseProperties($value) {
745 $propArray = explode(';', $value);
746 $propResultArray = array();
747 foreach ($propArray as $prop) {
748 $prop = trim($prop);
749 $pos = strpos($prop, '=');
750 if ($pos > 0) {
751 $key = trim(substr($prop, 0, $pos));
752 $val = trim(substr($prop, $pos+1));
753 if (strlen($val) > 0 && $val{0} == '"') {
754 $val = substr($val, 1, -1);
755 }
756 $propResultArray[$key] = $val;
757 }
758 }
759 return $this->processParameters($propResultArray);
760 }
761
762 /**
763 * Fills disposition object in rfc822Header object
764 * @param string $value
765 */
766 function parseDisposition($value) {
767 $pos = strpos($value, ';');
768 $props = '';
769 if ($pos > 0) {
770 $name = trim(substr($value, 0, $pos));
771 $props = trim(substr($value, $pos+1));
772 } else {
773 $name = $value;
774 }
775 $props_a = $this->parseProperties($props);
776 $disp = new Disposition($name);
777 $disp->properties = $props_a;
778 $this->disposition = $disp;
779 }
780
781 /**
782 * Fills mlist array keys in rfc822Header object
783 * @param string $field
784 * @param string $value
785 */
786 function mlist($field, $value) {
787 $res_a = array();
788 $value_a = explode(',', $value);
789 foreach ($value_a as $val) {
790 $val = trim($val);
791 if ($val{0} == '<') {
792 $val = substr($val, 1, -1);
793 }
794 if (substr($val, 0, 7) == 'mailto:') {
795 $res_a['mailto'] = substr($val, 7);
796 } else {
797 $res_a['href'] = $val;
798 }
799 }
800 $this->mlist[$field] = $res_a;
801 }
802
803 /**
804 * Parses the X-Spam-Status header
805 * @param string $value
806 */
807 function parseSpamStatus($value) {
808 // Header value looks like this:
809 // 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
810
811 $spam_status = array();
812
813 if (preg_match ('/^(No|Yes),\s+score=(-?\d+\.\d+)\s+required=(-?\d+\.\d+)\s+tests=(.*?)\s+autolearn=(.*?)\s+version=(.+?)$/', $value, $matches)) {
814 // full header
815 $spam_status['bad_format'] = 0;
816 $spam_status['value'] = $matches[0];
817 // is_spam
818 if (isset($matches[1])
819 && strtolower($matches[1]) == 'yes') {
820 $spam_status['is_spam'] = true;
821 } else {
822 $spam_status['is_spam'] = false;
823 }
824
825 // score
826 $spam_status['score'] = $matches[2];
827
828 // required
829 $spam_status['required'] = $matches[3];
830
831 // tests
832 $tests = array();
833 $tests = explode(',', $matches[4]);
834 foreach ($tests as $test) {
835 $spam_status['tests'][] = trim($test);
836 }
837
838 // autolearn
839 $spam_status['autolearn'] = $matches[5];
840
841 // version
842 $spam_status['version'] = $matches[6];
843 } else {
844 $spam_status['bad_format'] = 1;
845 $spam_status['value'] = $value;
846 }
847 return $spam_status;
848 }
849
850 /**
851 * function to get the address strings out of the header.
852 * example1: header->getAddr_s('to').
853 * example2: header->getAddr_s(array('to', 'cc', 'bcc'))
854 * @param mixed $arr string or array of strings
855 * @param string $separator
856 * @param boolean $encoded (since 1.4.0) return encoded or plain text addresses
857 * @return string
858 */
859 function getAddr_s($arr, $separator = ',',$encoded=false) {
860 $s = '';
861
862 if (is_array($arr)) {
863 foreach($arr as $arg) {
864 if ($this->getAddr_s($arg, $separator, $encoded)) {
865 $s .= $separator;
866 }
867 }
868 $s = ($s ? substr($s, 2) : $s);
869 } else {
870 $addr = $this->{$arr};
871 if (is_array($addr)) {
872 foreach ($addr as $addr_o) {
873 if (is_object($addr_o)) {
874 if ($encoded) {
875 $s .= $addr_o->getEncodedAddress() . $separator;
876 } else {
877 $s .= $addr_o->getAddress() . $separator;
878 }
879 }
880 }
881 $s = substr($s, 0, -strlen($separator));
882 } else {
883 if (is_object($addr)) {
884 if ($encoded) {
885 $s .= $addr->getEncodedAddress();
886 } else {
887 $s .= $addr->getAddress();
888 }
889 }
890 }
891 }
892 return $s;
893 }
894
895 /**
896 * function to get the array of addresses out of the header.
897 * @param mixed $arg string or array of strings
898 * @param array $excl_arr array of excluded email addresses
899 * @param array $arr array of added email addresses
900 * @return array
901 */
902 function getAddr_a($arg, $excl_arr = array(), $arr = array()) {
903 if (is_array($arg)) {
904 foreach($arg as $argument) {
905 $arr = $this->getAddr_a($argument, $excl_arr, $arr);
906 }
907 } else {
908 $addr = $this->{$arg};
909 if (is_array($addr)) {
910 foreach ($addr as $next_addr) {
911 if (is_object($next_addr)) {
912 if (isset($next_addr->host) && ($next_addr->host != '')) {
913 $email = $next_addr->mailbox . '@' . $next_addr->host;
914 } else {
915 $email = $next_addr->mailbox;
916 }
917 $email = strtolower($email);
918 if ($email && !isset($arr[$email]) && !isset($excl_arr[$email])) {
919 $arr[$email] = $next_addr->personal;
920 }
921 }
922 }
923 } else {
924 if (is_object($addr)) {
925 $email = $addr->mailbox;
926 $email .= (isset($addr->host) ? '@' . $addr->host : '');
927 $email = strtolower($email);
928 if ($email && !isset($arr[$email]) && !isset($excl_arr[$email])) {
929 $arr[$email] = $addr->personal;
930 }
931 }
932 }
933 }
934 return $arr;
935 }
936
937 /**
938 //FIXME: This needs some documentation (inside the function too)! Don't code w/out comments!
939 * @param mixed $address array or string
940 * @param boolean $recurs
941 * @return mixed array, boolean
942 * @since 1.3.2
943 */
944 function findAddress($address, $recurs = false) {
945 $result = false;
946 if (is_array($address)) {
947 $i=0;
948 foreach($address as $argument) {
949 $match = $this->findAddress($argument, true);
950 if ($match[1]) {
951 return $i;
952 } else {
953 if (count($match[0]) && !$result) {
954 $result = $i;
955 }
956 }
957 ++$i;
958 }
959 } else {
960 if (!is_array($this->cc)) $this->cc = array();
961 if (!is_array($this->to)) $this->to = array();
962 $srch_addr = $this->parseAddress($address);
963 $results = array();
964 foreach ($this->to as $to) {
965 if (strtolower($to->host) == strtolower($srch_addr->host)) {
966 if (strtolower($to->mailbox) == strtolower($srch_addr->mailbox)) {
967 $results[] = $srch_addr;
968 if (strtolower($to->personal) == strtolower($srch_addr->personal)) {
969 if ($recurs) {
970 return array($results, true);
971 } else {
972 return true;
973 }
974 }
975 }
976 }
977 }
978 foreach ($this->cc as $cc) {
979 if (strtolower($cc->host) == strtolower($srch_addr->host)) {
980 if (strtolower($cc->mailbox) == strtolower($srch_addr->mailbox)) {
981 $results[] = $srch_addr;
982 if (strtolower($cc->personal) == strtolower($srch_addr->personal)) {
983 if ($recurs) {
984 return array($results, true);
985 } else {
986 return true;
987 }
988 }
989 }
990 }
991 }
992 if ($recurs) {
993 return array($results, false);
994 } elseif (count($result)) {
995 return true;
996 } else {
997 return false;
998 }
999 }
1000 //exit;
1001 return $result;
1002 }
1003
1004 /**
1005 * @param string $type0 media type
1006 * @param string $type1 media subtype
1007 * @return array media properties
1008 * @todo check use of media type arguments
1009 */
1010 function getContentType($type0, $type1) {
1011 $type0 = $this->content_type->type0;
1012 $type1 = $this->content_type->type1;
1013 return $this->content_type->properties;
1014 }
1015 }