functions/mime.php

   1 <?php
   2    /** mime.php
   3     **
   4     ** This contains the functions necessary to detect and decode MIME
   5     ** messages.
   6     **
   7     ** $Id$
   8     **/
   9
  10    $debug_mime = false;
  11    $mime_php = true;
  12
  13    if (!isset($i18n_php))
  14       include "../functions/i18n.php";
  15    if (!isset($imap_php))
  16       include "../functions/imap.php";
  17    if (!isset($config_php))
  18       include "../config/config.php";
  19
  20
  21    /** Setting up the objects that have the structure for the message **/
  22
  23    class msg_header {
  24       /** msg_header contains generic variables for values that **/
  25       /** could be in a header.                                 **/
  26
  27       var $type0 = '', $type1 = '', $boundary = '', $charset = '';
  28       var $encoding = '', $size = 0, $to = '', $from = '', $date = '';
  29       var $cc = '', $bcc = '', $reply_to = '', $subject = '';
  30       var $id = 0, $mailbox = '', $description = '';
  31       var $entity_id = 0, $message_id = 0;
  32    }
  33
  34    class message {
  35       /** message is the object that contains messages.  It is a recursive
  36           object in that through the $entities variable, it can contain
  37           more objects of type message.  See documentation in mime.txt for
  38           a better description of how this works.
  39        **/
  40       var $header;
  41       var $entities;
  42
  43       function addEntity ($msg) {
  44          $this->entities[count($this->entities)] = $msg;
  45       }
  46    }
  47
  48
  49
  50    /* --------------------------------------------------------------------------------- */
  51    /* MIME DECODING                                                                     */
  52    /* --------------------------------------------------------------------------------- */
  53
  54    // This function gets the structure of a message and stores it in the "message" class.
  55    // It will return this object for use with all relevant header information and
  56    // fully parsed into the standard "message" object format.
  57    function mime_structure ($imap_stream, $header) {
  58       global $debug_mime;
  59       sqimap_messages_flag ($imap_stream, $header->id, $header->id, "Seen");
  60
  61       $id = $header->id;
  62       fputs ($imap_stream, "a001 FETCH $id BODYSTRUCTURE\r\n");
  63       //
  64       // This should use sqimap_read_data instead of reading it itself
  65       //
  66       $read = fgets ($imap_stream, 10000);
  67       $response = substr($read, 0, 4);
  68       $bodystructure = "";
  69       while ($response != "a001") {
  70          $bodystructure .= $read;
  71          $read = fgets ($imap_stream, 10000);
  72          $response = substr($read, 0, 4);
  73       }
  74       $read = $bodystructure;
  75
  76       if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
  77       // isolate the body structure and remove beginning and end parenthesis
  78       $read = trim(substr ($read, strpos(strtolower($read), "bodystructure") + 13));
  79       $read = trim(substr ($read, 0, -1));
  80       $end = mime_match_parenthesis(0, $read);
  81       while ($end == strlen($read)-1) {
  82          $read = trim(substr ($read, 0, -1));
  83          $read = trim(substr ($read, 1));
  84          $end = mime_match_parenthesis(0, $read);
  85       }
  86
  87       if ($debug_mime) echo "<tt>$read</tt><br><br>\n";
  88
  89       $msg = mime_parse_structure ($read, 0);
  90       $msg->header = $header;
  91       return $msg;
  92    }
  93
  94    // this starts the parsing of a particular structure.  It is called recursively,
  95    // so it can be passed different structures.  It returns an object of type
  96    // $message.
  97    // First, it checks to see if it is a multipart message.  If it is, then it
  98    // handles that as it sees is necessary.  If it is just a regular entity,
  99    // then it parses it and adds the necessary header information (by calling out
 100    // to mime_get_elements()
 101    function mime_parse_structure ($structure, $ent_id) {
 102       global $debug_mime;
 103       if ($debug_mime) echo "<font color=008800><tt>START: mime_parse_structure()</tt></font><br>\n";
 104       $msg = new message();
 105       if (substr($structure, 0, 1) == "(") {
 106          $ent_id = mime_new_element_level($ent_id);
 107          $start = $end = -1;
 108          if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
 109          do {
 110             if ($debug_mime) echo "<font color=008800><tt>Found entity...</tt></font><br>";
 111             $start = $end+1;
 112             $end = mime_match_parenthesis ($start, $structure);
 113
 114             $element = substr($structure, $start+1, ($end - $start)-1);
 115             $ent_id = mime_increment_id ($ent_id);
 116             $newmsg = mime_parse_structure ($element, $ent_id);
 117             $msg->addEntity ($newmsg);
 118          } while (substr($structure, $end+1, 1) == "(");
 119       } else {
 120          // parse the elements
 121          if ($debug_mime) echo "<br><font color=0000aa><tt>$structure</tt></font><br>";
 122          $msg = mime_get_element (&$structure, $msg, $ent_id);
 123          if ($debug_mime) echo "<br>";
 124       }
 125       return $msg;
 126       if ($debug_mime) echo "<font color=008800><tt>&nbsp;&nbsp;END: mime_parse_structure()</tt></font><br>";
 127    }
 128
 129    // Increments the element ID.  An element id can look like any of
 130    // the following:  1, 1.2, 4.3.2.4.1, etc.  This function increments
 131    // the last number of the element id, changing 1.2 to 1.3.
 132    function mime_increment_id ($id) {
 133       global $debug_mime;
 134       if (strpos($id, ".")) {
 135          $first = substr($id, 0, strrpos($id, "."));
 136          $last = substr($id, strrpos($id, ".")+1);
 137          $last++;
 138          $new = $first . "." .$last;
 139       } else {
 140          $new = $id + 1;
 141       }
 142       if ($debug_mime) echo "<b>INCREMENT: $new</b><br>";
 143       return $new;
 144    }
 145
 146    // See comment for mime_increment_id().
 147    // This adds another level on to the entity_id changing 1.3 to 1.3.0
 148    // NOTE:  1.3.0 is not a valid element ID.  It MUST be incremented
 149    //        before it can be used.  I left it this way so as not to have
 150    //        to make a special case if it is the first entity_id.  It
 151    //        always increments it, and that works fine.
 152    function mime_new_element_level ($id) {
 153       if (!$id) $id = 0;
 154       else      $id = $id . ".0";
 155
 156       return $id;
 157    }
 158
 159    function mime_get_element (&$structure, $msg, $ent_id) {
 160       global $debug_mime;
 161       $elem_num = 1;
 162       $msg->header = new msg_header();
 163       $msg->header->entity_id = $ent_id;
 164
 165       while (strlen($structure) > 0) {
 166          $structure = trim($structure);
 167          $char = substr($structure, 0, 1);
 168
 169          if (strtolower(substr($structure, 0, 3)) == "nil") {
 170             $text = "";
 171             $structure = substr($structure, 3);
 172          } else if ($char == "\"") {
 173             // loop through until we find the matching quote, and return that as a string
 174             $pos = 1;
 175             $char = substr($structure, $pos, 1);
 176             $text = "";
 177             while ($char != "\"" && $pos < strlen($structure)) {
 178                $text .= $char;
 179                $pos++;
 180                $char = substr($structure, $pos, 1);
 181             }
 182             $structure = substr($structure, strlen($text) + 2);
 183          } else if ($char == "(") {
 184             // comment me
 185             $end = mime_match_parenthesis (0, $structure);
 186             $sub = substr($structure, 1, $end-1);
 187             if (! isset($properties))
 188                 $properties = array();
 189             $properties = mime_get_props($properties, $sub);
 190             $structure = substr($structure, strlen($sub) + 2);
 191          } else {
 192             // loop through until we find a space or an end parenthesis
 193             $pos = 0;
 194             $char = substr($structure, $pos, 1);
 195             while ($char != " " && $char != ")" && $pos < strlen($structure)) {
 196                $text .= $char;
 197                $pos++;
 198                $char = substr($structure, $pos, 1);
 199             }
 200             $structure = substr($structure, strlen($text));
 201          }
 202          if ($debug_mime) echo "<tt>$elem_num : $text</tt><br>";
 203
 204          // This is where all the text parts get put into the header
 205          switch ($elem_num) {
 206             case 1:
 207                $msg->header->type0 = strtolower($text);
 208                if ($debug_mime) echo "<tt>type0 = ".strtolower($text)."</tt><br>";
 209                break;
 210             case 2:
 211                $msg->header->type1 = strtolower($text);
 212                if ($debug_mime) echo "<tt>type1 = ".strtolower($text)."</tt><br>";
 213                break;
 214             case 5:
 215                $msg->header->description = $text;
 216                if ($debug_mime) echo "<tt>description = $text</tt><br>";
 217                break;
 218             case 6:
 219                $msg->header->encoding = strtolower($text);
 220                if ($debug_mime) echo "<tt>encoding = ".strtolower($text)."</tt><br>";
 221                break;
 222             case 7:
 223                $msg->header->size = $text;
 224                if ($debug_mime) echo "<tt>size = $text</tt><br>";
 225                break;
 226             default:
 227                if ($msg->header->type0 == "text" && $elem_num == 8) {
 228                   // This is a plain text message, so lets get the number of lines
 229                   // that it contains.
 230                   $msg->header->num_lines = $text;
 231                   if ($debug_mime) echo "<tt>num_lines = $text</tt><br>";
 232
 233                } else if ($msg->header->type0 == "message" && $msg->header->type1 == "rfc822" && $elem_num == 8) {
 234                   // This is an encapsulated message, so lets start all over again and
 235                   // parse this message adding it on to the existing one.
 236                   $structure = trim($structure);
 237                   if (substr($structure, 0, 1) == "(") {
 238                      $e = mime_match_parenthesis (0, $structure);
 239                      $structure = substr($structure, 0, $e);
 240                      $structure = substr($structure, 1);
 241                      $m = mime_parse_structure($structure, $msg->header->entity_id);
 242
 243                      // the following conditional is there to correct a bug that wasn't
 244                      // incrementing the entity IDs correctly because of the special case
 245                      // that message/rfc822 is.  This fixes it fine.
 246                      if (substr($structure, 1, 1) != "(")
 247                         $m->header->entity_id = mime_increment_id(mime_new_element_level($ent_id));
 248
 249                      // Now we'll go through and reformat the results.
 250                      if ($m->entities) {
 251                         for ($i=0; $i < count($m->entities); $i++) {
 252                            $msg->addEntity($m->entities[$i]);
 253                         }
 254                      } else {
 255                         $msg->addEntity($m);
 256                      }
 257                      $structure = "";
 258                   }
 259                }
 260                break;
 261          }
 262          $elem_num++;
 263          $text = "";
 264       }
 265       // loop through the additional properties and put those in the various headers
 266       if ($msg->header->type0 != "message") {
 267          for ($i=0; $i < count($properties); $i++) {
 268             $msg->header->{$properties[$i]["name"]} = $properties[$i]["value"];
 269             if ($debug_mime) echo "<tt>".$properties[$i]["name"]." = " . $properties[$i]["value"] . "</tt><br>";
 270          }
 271       }
 272
 273       return $msg;
 274    }
 275
 276    // I did most of the MIME stuff yesterday (June 20, 2000), but I couldn't
 277    // figure out how to do this part, so I decided to go to bed.  I woke up
 278    // in the morning and had a flash of insight.  I went to the white-board
 279    // and scribbled it out, then spent a bit programming it, and this is the
 280    // result.  Nothing complicated, but I think my brain was fried yesterday.
 281    // Funny how that happens some times.
 282    //
 283    // This gets properties in a nested parenthesisized list.  For example,
 284    // this would get passed something like:  ("attachment" ("filename" "luke.tar.gz"))
 285    // This returns an array called $props with all paired up properties.
 286    // It ignores the "attachment" for now, maybe that should change later
 287    // down the road.  In this case, what is returned is:
 288    //    $props[0]["name"] = "filename";
 289    //    $props[0]["value"] = "luke.tar.gz";
 290    function mime_get_props ($props, $structure) {
 291       global $debug_mime;
 292       while (strlen($structure) > 0) {
 293          $structure = trim($structure);
 294          $char = substr($structure, 0, 1);
 295
 296          if ($char == "\"") {
 297             $pos = 1;
 298             $char = substr($structure, $pos, 1);
 299             $tmp = "";
 300             while ($char != "\"" && $pos < strlen($structure)) {
 301                $tmp .= $char;
 302                $pos++;
 303                $char = substr($structure, $pos, 1);
 304             }
 305             $structure = trim(substr($structure, strlen($tmp) + 2));
 306             $char = substr($structure, 0, 1);
 307
 308             if ($char == "\"") {
 309                $pos = 1;
 310                $char = substr($structure, $pos, 1);
 311                $value = "";
 312                while ($char != "\"" && $pos < strlen($structure)) {
 313                   $value .= $char;
 314                   $pos++;
 315                   $char = substr($structure, $pos, 1);
 316                }
 317                $structure = trim(substr($structure, strlen($tmp) + 2));
 318
 319                $k = count($props);
 320                $props[$k]["name"] = strtolower($tmp);
 321                $props[$k]["value"] = $value;
 322             } else if ($char == "(") {
 323                $end = mime_match_parenthesis (0, $structure);
 324                $sub = substr($structure, 1, $end-1);
 325                if (! isset($props))
 326                    $props = array();
 327                $props = mime_get_props($props, $sub);
 328                $structure = substr($structure, strlen($sub) + 2);
 329             }
 330             return $props;
 331          } else if ($char == "(") {
 332             $end = mime_match_parenthesis (0, $structure);
 333             $sub = substr($structure, 1, $end-1);
 334             $props = mime_get_props($props, $sub);
 335             $structure = substr($structure, strlen($sub) + 2);
 336             return $props;
 337          } else {
 338             return $props;
 339          }
 340       }
 341    }
 342
 343    //  Matches parenthesis.  It will return the position of the matching
 344    //  parenthesis in $structure.  For instance, if $structure was:
 345    //     ("text" "plain" ("val1name", "1") nil ... )
 346    //     x                                         x
 347    //  then this would return 42 to match up those two.
 348    function mime_match_parenthesis ($pos, $structure) {
 349       $char = substr($structure, $pos, 1);
 350
 351       // ignore all extra characters
 352       // If inside of a string, skip string -- Boundary IDs and other
 353       // things can have ) in them.
 354       while ($pos < strlen($structure)) {
 355          $pos++;
 356          $char = substr($structure, $pos, 1);
 357          if ($char == ")") {
 358             return $pos;
 359          } else if ($char == '"') {
 360             $pos ++;
 361             while (substr($structure, $pos, 1) != '"' &&
 362                $pos < strlen($structure)) {
 363                $pos ++;
 364             }
 365          } else if ($char == "(") {
 366             $pos = mime_match_parenthesis ($pos, $structure);
 367          }
 368       }
 369    }
 370
 371    function mime_fetch_body ($imap_stream, $id, $ent_id) {
 372       // do a bit of error correction.  If we couldn't find the entity id, just guess
 373       // that it is the first one.  That is usually the case anyway.
 374       if (!$ent_id) $ent_id = 1;
 375
 376       fputs ($imap_stream, "a010 FETCH $id BODY[$ent_id]\r\n");
 377       $data = sqimap_read_data ($imap_stream, 'a010', true, $response, $message);
 378       $topline = array_shift($data);
 379       while (! ereg('\* [0-9]+ FETCH ', $topline) && data)
 380           $topline = array_shift($data);
 381       $wholemessage = implode('', $data);
 382
 383       if (ereg('\{([^\}]*)\}', $topline, $regs)) {
 384          return substr($wholemessage, 0, $regs[1]);
 385       }
 386       else if (ereg('"([^"]*)"', $topline, $regs)) {
 387          return $regs[1];
 388       }
 389
 390       $str = "Body retrival error.  Please report this bug!\n";
 391       $str .= "Response:  $response\n";
 392       $str .= "Message:  $message\n";
 393       $str .= "FETCH line:  $topline";
 394       $str .= "---------------\n$wholemessage";
 395       foreach ($data as $d)
 396       {
 397           $str .= htmlspecialchars($d) . "\n";
 398       }
 399       return $str;
 400
 401       return "Body retrival error, please report this bug!\n\nTop line is \"$topline\"\n";
 402    }
 403
 404    function mime_print_body_lines ($imap_stream, $id, $ent_id, $encoding) {
 405       // do a bit of error correction.  If we couldn't find the entity id, just guess
 406       // that it is the first one.  That is usually the case anyway.
 407       if (!$ent_id) $ent_id = 1;
 408
 409       fputs ($imap_stream, "a001 FETCH $id BODY[$ent_id]\r\n");
 410           $cnt = 0;
 411           $continue = true;
 412                 $read = fgets ($imap_stream,4096);
 413                 while (!ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
 414                         if (trim($read) == ")==") {
 415                                 $read1 = $read;
 416                                 $read = fgets ($imap_stream,4096);
 417                                 if (ereg("^a001 (OK|BAD|NO)(.*)$", $read, $regs)) {
 418                                         return;
 419                                 } else {
 420                                         echo decodeBody($read1, $encoding);
 421                                         echo decodeBody($read, $encoding);
 422                                 }
 423                         } else if ($cnt) {
 424                                 echo decodeBody($read, $encoding);
 425                         }
 426                         $read = fgets ($imap_stream,4096);
 427                         $cnt++;
 428                 }
 429    }
 430
 431    /* -[ END MIME DECODING ]----------------------------------------------------------- */
 432
 433
 434
 435    /** This is the first function called.  It decides if this is a multipart
 436        message or if it should be handled as a single entity
 437     **/
 438    function decodeMime ($imap_stream, $header) {
 439       global $username, $key, $imapServerAddress, $imapPort;
 440       return mime_structure ($imap_stream, $header);
 441    }
 442
 443    // This is here for debugging purposese.  It will print out a list
 444    // of all the entity IDs that are in the $message object.
 445    function listEntities ($message) {
 446       if ($message) {
 447          if ($message->header->entity_id)
 448          echo "<tt>" . $message->header->entity_id . " : " . $message->header->type0 . "/" . $message->header->type1 . "<br>";
 449          for ($i = 0; $message->entities[$i]; $i++) {
 450             $msg = listEntities($message->entities[$i], $ent_id);
 451             if ($msg)
 452                return $msg;
 453          }
 454       }
 455    }
 456
 457    // returns a $message object for a particular entity id
 458    function getEntity ($message, $ent_id) {
 459       if ($message) {
 460          if ($message->header->entity_id == $ent_id && strlen($ent_id) == strlen($message->header->entity_id)) {
 461             return $message;
 462          } else {
 463             for ($i = 0; $message->entities[$i]; $i++) {
 464                $msg = getEntity ($message->entities[$i], $ent_id);
 465                if ($msg)
 466                   return $msg;
 467             }
 468          }
 469       }
 470    }
 471
 472    // figures out what entity to display and returns the $message object
 473    // for that entity.
 474    function findDisplayEntity ($message) {
 475       if ($message) {
 476          if ($message->header->type0 == "text") {
 477             if ($message->header->type1 == "plain" ||
 478                 $message->header->type1 == "html") {
 479                if (isset($message->header->entity_id))
 480                    return $message->header->entity_id;
 481                return 0;
 482             }
 483          } else {
 484             for ($i=0; $message->entities[$i]; $i++) {
 485                return findDisplayEntity($message->entities[$i]);
 486             }
 487          }
 488       }
 489    }
 490
 491    /** This returns a parsed string called $body. That string can then
 492        be displayed as the actual message in the HTML. It contains
 493        everything needed, including HTML Tags, Attachments at the
 494        bottom, etc.
 495     **/
 496    function formatBody($imap_stream, $message, $color, $wrap_at) {
 497       // this if statement checks for the entity to show as the
 498       // primary message. To add more of them, just put them in the
 499       // order that is their priority.
 500       global $startMessage, $username, $key, $imapServerAddress, $imapPort;
 501
 502       $id = $message->header->id;
 503       $urlmailbox = urlencode($message->header->mailbox);
 504
 505       // Get the right entity and redefine message to be this entity
 506       $ent_num = findDisplayEntity ($message);
 507       $body_message = getEntity($message, $ent_num);
 508       if (($body_message->header->type0 == "text") ||
 509           ($body_message->header->type0 == "rfc822")) {
 510
 511          $body = mime_fetch_body ($imap_stream, $id, $ent_num);
 512          $body = decodeBody($body, $body_message->header->encoding);
 513
 514          // If there are other types that shouldn't be formatted, add
 515          // them here
 516          if ($body_message->header->type1 != "html") {
 517             translateText($body, $wrap_at, $body_message->header->charset);
 518          }
 519
 520          $body .= "<SMALL><CENTER><A HREF=\"../src/download.php?absolute_dl=true&passed_id=$id&passed_ent_id=$ent_num&mailbox=$urlmailbox\">". _("Download this as a file") ."</A></CENTER><BR></SMALL>";
 521
 522          /** Display the ATTACHMENTS: message if there's more than one part **/
 523          $body .= "</TD></TR></TABLE>";
 524          if (isset($message->entities)) {
 525             $body .= formatAttachments ($message, $ent_num, $message->header->mailbox, $id);
 526          }
 527       } else {
 528          $body .= formatAttachments ($message, -1, $message->header->mailbox, $id);
 529       }
 530       return $body;
 531    }
 532
 533    // A recursive function that returns a list of attachments with links
 534    // to where to download these attachments
 535    function formatAttachments ($message, $ent_id, $mailbox, $id) {
 536       global $where, $what;
 537       global $startMessage, $color;
 538       static $ShownHTML;
 539
 540       if ($ShownHTML == 0)
 541       {
 542             $ShownHTML = 1;
 543
 544             $body .= "<TABLE WIDTH=100% CELLSPACING=0 CELLPADDING=2 BORDER=0 BGCOLOR=\"$color[0]\"><TR>\n";
 545             $body .= "<TH ALIGN=\"left\" BGCOLOR=\"$color[9]\"><B>\n";
 546             $body .= _('Attachments') . ':';
 547             $body .= "</B></TH></TR><TR><TD>\n";
 548
 549             $body .= "<TABLE CELLSPACING=0 CELLPADDING=1 BORDER=0>\n";
 550
 551             $body .= formatAttachments ($message, $ent_id, $mailbox, $id);
 552
 553             $body .= "</TABLE></TD></TR></TABLE>";
 554
 555             return $body;
 556       }
 557
 558       if ($message) {
 559          if (!$message->entities) {
 560             $type0 = strtolower($message->header->type0);
 561             $type1 = strtolower($message->header->type1);
 562
 563             if ($message->header->entity_id != $ent_id) {
 564                $filename = decodeHeader($message->header->filename);
 565                if (trim($filename) == "") {
 566                   $display_filename = "untitled-".$message->header->entity_id;
 567                } else {
 568                   $display_filename = $filename;
 569                }
 570
 571                $urlMailbox = urlencode($mailbox);
 572                $ent = urlencode($message->header->entity_id);
 573
 574                $DefaultLink =
 575                   "../src/download.php?startMessage=$startMessage&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
 576                if ($where && $what)
 577                   $DefaultLink .= '&where=' . urlencode($where) . '&what=' . urlencode($what);
 578                $Links['download link']['text'] = _('download');
 579                $Links['download link']['href'] =
 580                    "../src/download.php?absolute_dl=true&passed_id=$id&mailbox=$urlMailbox&passed_ent_id=$ent";
 581                $ImageURL = '';
 582
 583                $HookResults = do_hook("attachment $type0/$type1", $Links,
 584                    $startMessage, $id, $urlMailbox, $ent, $DefaultLink,
 585                    $display_filename, $where, $what);
 586
 587                $Links = $HookResults[1];
 588                $DefaultLink = $HookResults[6];
 589
 590                $body .= '<TR><TD>&nbsp;&nbsp;</TD><TD>';
 591                $body .= "<A HREF=\"$DefaultLink\">$display_filename</A>&nbsp;</TD>";
 592                $body .= '<TD><SMALL><b>' . show_readable_size($message->header->size) .
 593                    '</b>&nbsp;&nbsp;</small></TD>';
 594                $body .= "<TD><SMALL>[ $type0/$type1 ]&nbsp;</SMALL></TD>";
 595                $body .= '<TD><SMALL>';
 596                if ($message->header->description)
 597                   $body .= '<b>' . htmlspecialchars($message->header->description) . '</b>';
 598                $body .= '</SMALL></TD><TD><SMALL>&nbsp;';
 599
 600
 601                $SkipSpaces = 1;
 602                foreach ($Links as $Val)
 603                {
 604                   if ($SkipSpaces)
 605                   {
 606                      $SkipSpaces = 0;
 607                   }
 608                   else
 609                   {
 610                      $body .= '&nbsp;&nbsp;|&nbsp;&nbsp;';
 611                   }
 612                   $body .= '<a href="' . $Val['href'] . '">' .  $Val['text'] . '</a>';
 613                }
 614
 615                unset($Links);
 616
 617                $body .= "</SMALL></TD></TR>\n";
 618             }
 619             return $body;
 620          } else {
 621             for ($i = 0; $i < count($message->entities); $i++) {
 622                $body .= formatAttachments ($message->entities[$i], $ent_id, $mailbox, $id);
 623             }
 624             return $body;
 625          }
 626       }
 627    }
 628
 629
 630    /** this function decodes the body depending on the encoding type. **/
 631    function decodeBody($body, $encoding) {
 632       $body = str_replace("\r\n", "\n", $body);
 633       $encoding = strtolower($encoding);
 634
 635       if ($encoding == "quoted-printable") {
 636          $body = quoted_printable_decode($body);
 637
 638          while (ereg("=\n", $body))
 639             $body = ereg_replace ("=\n", "", $body);
 640       } else if ($encoding == "base64") {
 641          $body = base64_decode($body);
 642       }
 643
 644       // All other encodings are returned raw.
 645       return $body;
 646    }
 647
 648
 649    // This functions decode strings that is encoded according to
 650    // RFC1522 (MIME Part Two: Message Header Extensions for Non-ASCII Text).
 651    function decodeHeader ($string) {
 652       if (eregi('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
 653                 $string, $res)) {
 654          if (ucfirst($res[2]) == "B") {
 655             $replace = base64_decode($res[3]);
 656          } else {
 657             $replace = ereg_replace("_", " ", $res[3]);
 658             // Convert lowercase Quoted Printable to uppercase for
 659             // quoted_printable_decode to understand it.
 660             while (ereg("(=([0-9][abcdef])|([abcdef][0-9])|([abcdef][abcdef]))", $replace, $res)) {
 661                $replace = str_replace($res[1], strtoupper($res[1]), $replace);
 662             }
 663             $replace = quoted_printable_decode($replace);
 664          }
 665
 666          $replace = charset_decode ($res[1], $replace);
 667
 668          $string = eregi_replace
 669             ('=\?([^?]+)\?(q|b)\?([^?]+)\?=',
 670              $replace, $string);
 671          // In case there should be more encoding in the string: recurse
 672          return (decodeHeader($string));
 673       } else
 674          return ($string);
 675    }
 676
 677    // Encode a string according to RFC 1522 for use in headers if it
 678    // contains 8-bit characters or anything that looks like it should
 679    // be encoded.
 680    function encodeHeader ($string) {
 681       global $default_charset;
 682
 683       // Encode only if the string contains 8-bit characters or =?
 684       if (ereg("([\200-\377]|=\\?)", $string)) {
 685          $newstring = "=?$default_charset?Q?";
 686
 687          // First the special characters
 688          $string = str_replace("=", "=3D", $string);
 689          $string = str_replace("?", "=3F", $string);
 690          $string = str_replace("_", "=5F", $string);
 691          $string = str_replace(" ", "_", $string);
 692
 693          for ( $ch = 127 ; $ch <= 255 ; $ch++ ) {
 694             $replace = chr($ch);
 695             $insert = sprintf("=%02X", $ch);
 696             $string = str_replace($replace, $insert, $string);
 697             $ch++;
 698          }
 699
 700          $newstring = "=?$default_charset?Q?".$string."?=";
 701
 702          return $newstring;
 703       }
 704
 705       return $string;
 706    }
 707
 708 ?>