class.t3lib_readmail.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
class t3lib_readmail {
   var $dateAbbrevs = array(
      'JAN' => 1,
      'FEB' => 2,
      'MAR' => 3,
      'APR' => 4,
      'MAY' => 5,
      'JUN' => 6,
      'JUL' => 7,
      'AUG' => 8,
      'SEP' => 9,
      'OCT' => 10,
      'NOV' => 11,
      'DEC' => 12
   );
   var $serverGMToffsetMinutes = 60;      // = +0100 (CET)






   /*******************************
    *
    * FUNCTIONS for the Dmailer
    *
    ********************************/

   function find_MIDfromReturnPath($to)   {
      $parts = explode('mid',strtolower($to));
      $moreParts=explode('_',$parts[1]);
      $out=array(
         'mid' => $moreParts[0],
         'rtbl' => substr($moreParts[1],0,1),
         'rid' => intval(substr($moreParts[1],1))
      );
      if ($out['rtbl']=='p')     $out['rtbl']='P';

      return($out);
   }

   function find_XTypo3MID($content)   {
      if (strstr($content,'X-Typo3MID:')) {
         $p=explode('X-Typo3MID:',$content,2);
         $l=explode(chr(10),$p[1],2);
         list($mid,$hash)=t3lib_div::trimExplode('-',$l[0]);
         if (md5($mid)==$hash)   {
            $moreParts=explode('_',substr($mid,3));
            $out=array(
               'mid' => $moreParts[0],
               'rtbl' => substr($moreParts[1],0,1),
               'rid' => substr($moreParts[1],1)
            );
            return($out);
         }
      }
   }

















   /*******************************
    *
    * General
    *
    ********************************/

   function getMessage($mailParts)  {
      if ($mailParts['content-type'])  {
         $CType = $this->getCType($mailParts['content-type']);
         if ($CType['boundary']) {
            $parts = $this->getMailBoundaryParts($CType['boundary'],$mailParts['CONTENT']);
            $c=$this->getTextContent($parts[0]);
         } else {
            $c=$this->getTextContent(
               'Content-Type: '.$mailParts['content-type'].'
               '.$mailParts['CONTENT']
            );
         }
      } else {
         $c = $mailParts['CONTENT'];
      }
      return $c;
   }

   function getTextContent($content)   {
      $p=$this->extractMailHeader($content);
      // Here some decoding might be needed...
      // However we just return what is believed to be the proper notification:
      return $p['CONTENT'];
   }

   function getMailBoundaryParts($boundary,$content)  {
      $mParts = explode('--'.$boundary,$content);
      unset($mParts[0]);
      reset($mParts);
      $new=array();
      while(list(,$val)=each($mParts)) {
         if (trim($val)=='--') break;
         $new[] = ltrim($val);
      }
      return $new;
   }

   function getCType($str) {
      $parts = explode(';',$str);
      $cTypes=array();
      $cTypes['ContentType']=$parts[0];
      next($parts);
      while(list(,$ppstr)=each($parts))   {
         $mparts = explode('=',$ppstr,2);
         if (count($mparts)>1)   {
            $cTypes[strtolower(trim($mparts[0]))]=ereg_replace('^"','',trim(ereg_replace('"$','',trim($mparts[1]))));
         } else {
            $cTypes[]=$ppstr;
         }
      }
      return $cTypes;
   }

   function analyseReturnError($c)  {
      $cp=array();
      if (strstr($c,'--- Below this line is a copy of the message.'))   {     // QMAIL
         list($c)=explode('--- Below this line is a copy of the message.',$c);   // Splits by the QMAIL divider
         $cp['content']=trim($c);
         $parts = explode('>:',$c,2);
         $cp['reason_text']=trim($parts[1]);
         $cp['mailserver']='Qmail';
         if (eregi('550|no mailbox|account does not exist',$cp['reason_text']))  {
            $cp['reason']=550;   // 550 Invalid recipient
         } elseif (stristr($cp['reason_text'],'couldn\'t find any host named')) {
            $cp['reason']=2;  // Bad host
         } elseif (eregi('Error in Header|invalid Message-ID header',$cp['reason_text'])) {
            $cp['reason']=554;
         } else {
            $cp['reason']=-1;
         }
      } elseif (strstr($c,'The Postfix program'))  {     // Postfix
         $cp['content']=trim($c);
         $parts = explode('>:',$c,2);
         $cp['reason_text']=trim($parts[1]);
         $cp['mailserver']='Postfix';
         if (stristr($cp['reason_text'],'550')) {
            $cp['reason']=550;   // 550 Invalid recipient, User unknown
         } elseif (stristr($cp['reason_text'],'553')) {
            $cp['reason']=553;   // No such user
         } elseif (stristr($cp['reason_text'],'551')) {
            $cp['reason']=551;   // Mailbox full
         } else {
            $cp['reason']=-1;
         }
      } else { // No-named:
         $cp['content']=trim($c);
         $cp['reason_text']=trim(substr($c,0,1000));
         $cp['mailserver']='unknown';
         if (eregi('Unknown Recipient|Delivery failed 550|Receiver not found|User not listed|recipient problem|Delivery to the following recipients failed|User unknown|recipient name is not recognized',$cp['reason_text']))   {
            $cp['reason']=550;   // 550 Invalid recipient, User unknown
         } elseif (eregi('over quota|mailbox full',$cp['reason_text'])) {
            $cp['reason']=551;
         } elseif (eregi('Error in Header',$cp['reason_text']))   {
            $cp['reason']=554;
         } else {
            $cp['reason']=-1;
         }
      }

      return $cp;
   }

   function decodeHeaderString($str)   {
      $parts = explode('=?',$str,2);
      if (count($parts)==2)   {
         list($charset,$encType,$encContent)=explode('?',$parts[1],3);
         $subparts =explode('?=',$encContent,2);
         $encContent=$subparts[0];

         switch(strtolower($encType))  {
            case 'q':
               $encContent = quoted_printable_decode($encContent);
               $encContent = str_replace('_',' ',$encContent);
            break;
            case 'b':
               $encContent=base64_decode($encContent);
            break;
         }

         $parts[1]=$encContent.$this->decodeHeaderString($subparts[1]); // Calls decodeHeaderString recursively for any subsequent encoded section.
      }
      return implode('',$parts);
   }

   function extractNameEmail($str)  {
      $outArr=array();

         // Email:
      $reg='';
      ereg('<([^>]*)>',$str,$reg);
      if (t3lib_div::validEmail($str)) {
         $outArr['email']=$str;
      } elseif ($reg[1] && t3lib_div::validEmail($reg[1]))  {
         $outArr['email']=$reg[1];
            // Find name:
         list($namePart)=explode($reg[0],$str);
         if (trim($namePart)) {
            $reg='';
            ereg('"([^"]*)"',$str,$reg);
            if (trim($reg[1]))   {
               $outArr['name']=trim($reg[1]);
            } else $outArr['name']=trim($namePart);
         }
      }
      return $outArr;
   }

   function getContentTypeData($contentTypeStr) {
      $outValue=array();
      $cTypeParts = t3lib_div::trimExplode(';',$contentTypeStr,1);
      $outValue['_MIME_TYPE']=$cTypeParts[0];   // content type, first value is supposed to be the mime-type, whatever after the first is something else.

      reset($cTypeParts);
      next($cTypeParts);
      while(list(,$v)=Each($cTypeParts))  {
         $reg='';
         eregi('([^=]*)="(.*)"',$v,$reg);
         if (trim($reg[1]) && trim($reg[2])) {
            $outValue[strtolower($reg[1])] = $reg[2];
         }
      }
      return $outValue;
   }

   function makeUnixDate($dateStr)  {
      $dateParts=explode(',',$dateStr);
      $dateStr=count($dateParts)>1 ? $dateParts[1] : $dateParts[0];

      $spaceParts = t3lib_div::trimExplode(' ',$dateStr,1);

      $spaceParts[1]=$this->dateAbbrevs[strtoupper($spaceParts[1])];
      $timeParts = explode(':',$spaceParts[3]);
      $timeStamp = mktime ($timeParts[0], $timeParts[1], $timeParts[2], $spaceParts[1], $spaceParts[0], $spaceParts[2]);

      $offset = $this->getGMToffset($spaceParts[4]);
      $timeStamp-=($offset*60);  // Compensates for GMT by subtracting the number of seconds which the date is offset from serverTime

      return $timeStamp;
   }

   function getGMToffset($GMT)   {
      $GMToffset=substr($GMT,1,2)*60+substr($GMT,3,2);
      $GMToffset*=substr($GMT,0,1)=='+'?1:-1;
      $GMToffset-=$this->serverGMToffsetMinutes;
      return $GMToffset;
   }

   function extractMailHeader($content,$limit=0)   {
      if ($limit) $content = substr($content,0,$limit);

      $lines=explode(chr(10),ltrim($content));
      $headers=array();
      $p='';
      while(list($k,$str)=each($lines))      {
         if (!trim($str))  break;   // header finished
         $parts = explode(' ',$str,2);
         if ($parts[0] && substr($parts[0],-1)==':')  {
            $p=strtolower(substr($parts[0],0,-1));
            if (isset($headers[$p]))   {
               $headers[$p.'.'][]=$headers[$p];
               $headers[$p]='';
            }
            $headers[$p]=trim($parts[1]);
         } else {
            $headers[$p].=' '.trim($str);
         }
         unset($lines[$k]);
      }
      if (!$limit)   $headers['CONTENT']=ltrim(implode(chr(10),$lines));
      return $headers;
   }

   function fullParse($content)  {
         // *************************
         // PROCESSING the HEADER part of the mail
         // *************************

         // Splitting header and body of mail:
      $mailParts = $this->extractMailHeader($content);

         // Decoding header values which potentially can be encoded by =?...?=
      $list = explode(',','subject,thread-topic,from,to');
      while(list(,$headerType)=each($list))  {
         if (isset($mailParts[$headerType])) $mailParts[$headerType]=$this->decodeHeaderString($mailParts[$headerType]);
      }
         // Separating email/names from header fields which can contain email addresses.
      $list = explode(',','from,to,reply-to,sender,return-path');
      while(list(,$headerType)=each($list))  {
         if (isset($mailParts[$headerType])) {
            $mailParts['_'.strtoupper($headerType)]=$this->extractNameEmail($mailParts[$headerType]);
         }
      }
         // Decode date from human-readable format to unix-time (includes compensation for GMT CET)
      $mailParts['_DATE']=$this->makeUnixDate($mailParts['date']);

         // Transfer encodings of body content
      switch(strtolower($mailParts['content-transfer-encoding'])) {
         case 'quoted-printable':
            $mailParts['CONTENT']=quoted_printable_decode($mailParts['CONTENT']);
         break;
         case 'base64':
            $mailParts['CONTENT']=base64_decode($mailParts['CONTENT']);
         break;
      }

         // Content types
      $mailParts['_CONTENT_TYPE_DAT']=$this->getContentTypeData($mailParts['content-type']);


         // *************************
         // PROCESSING the CONTENT part of the mail (the body)
         // *************************
      $cType = strtolower($mailParts['_CONTENT_TYPE_DAT']['_MIME_TYPE']);
      $cType = substr($cType,0,9);  // only looking for 'multipart' in string.
      switch($cType) {
/*       case 'multipart/mixed':
         case 'multipart/related':
         case 'multipart/alternative':
         case 'multipart/signed':
*/
         case 'multipart':
            if ($mailParts['_CONTENT_TYPE_DAT']['boundary'])   {
               $contentSectionParts = t3lib_div::trimExplode('--'.$mailParts['_CONTENT_TYPE_DAT']['boundary'],$mailParts['CONTENT'],1);
               $contentSectionParts_proc=array();

               reset($contentSectionParts);
               while(list($k,$v)=each($contentSectionParts))   {
                  if (substr($v,0,2)=='--')  break;
                  $contentSectionParts_proc[$k]=$this->fullParse($v);
               }
               $mailParts['CONTENT']=$contentSectionParts_proc;
            } else $mailParts['CONTENT'] = 'ERROR: No boundary found.';
         break;
         default:
            if (strtolower($mailParts['_CONTENT_TYPE_DAT']['charset'])=='utf-8') {
               $mailParts['CONTENT']=utf8_decode($mailParts['CONTENT']);
            }
         break;
      }
      return $mailParts;
   }
}

if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_readmail.php'])   {
   include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_readmail.php']);
}
?>

---