t3lib_readmail Class Reference

List of all members.

Public Member Functions
	find_MIDfromReturnPath ($to)
	Returns special TYPO3 Message ID (MID) from input TO header (the return address of the sent mail from Dmailer.
	find_XTypo3MID ($content)
	Returns special TYPO3 Message ID (MID) from input mail content (used by Dmailer, return mails).
	getMessage ($mailParts)
	Returns the text content of a mail which has previously been parsed by eg.
	getTextContent ($content)
	Returns the body part of a raw mail message (including headers) Probably obsolete since the function fullParse() is more advanced and safer to use.
	getMailBoundaryParts ($boundary, $content)
	Splits the body of a mail into parts based on the boundary string given.
	getCType ($str)
	Returns Content Type plus more.
	analyseReturnError ($c)
	Analyses the return-mail content for the Dmailer module - used to find what reason there was for rejecting the mail Used by the Dmailer, but not exclusively.
	decodeHeaderString ($str)
	Decodes a header-string with the =?....?= syntax including base64/quoted-printable encoding.
	extractNameEmail ($str)
	Extracts name/email parts from a header field (like 'To:' or 'From:' with name/email mixed up.
Public Attributes
	$dateAbbrevs
	$serverGMToffsetMinutes = 60

---

Member Function Documentation

t3lib_readmail::analyseReturnError (  $  c  )

Analyses the return-mail content for the Dmailer module - used to find what reason there was for rejecting the mail Used by the Dmailer, but not exclusively. Parameters: string  message body/text Returns: array key/value pairs with analysis result. Eg. "reason", "content", "reason_text", "mailserver" etc. Definition at line 271 of file class.t3lib_readmail.php. References header(), and message(). { $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; }

t3lib_readmail::decodeHeaderString (  $  str  )

Decodes a header-string with the =?....?= syntax including base64/quoted-printable encoding. Parameters: string  A string (encoded or not) from a mail header, like sender name etc. Returns: string The input string, but with the parts in =?....?= decoded. Definition at line 326 of file class.t3lib_readmail.php. { $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); }

t3lib_readmail::extractNameEmail (  $  str  )

Extracts name/email parts from a header field (like 'To:' or 'From:' with name/email mixed up. Parameters: string  Value from a header field containing name/email values. Returns: array Array with the name and email in. Email is validated, otherwise not set. Definition at line 354 of file class.t3lib_readmail.php.

t3lib_readmail::find_MIDfromReturnPath (  $  to  )

Returns special TYPO3 Message ID (MID) from input TO header (the return address of the sent mail from Dmailer. Used by Dmailer, return mails) Parameters: string  email address, return address string Returns: mixed array with 'mid', 'rtbl' and 'rid' keys are returned. Definition at line 122 of file class.t3lib_readmail.php. References $out. { $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); }

t3lib_readmail::find_XTypo3MID (  $  content  )

Returns special TYPO3 Message ID (MID) from input mail content (used by Dmailer, return mails). Parameters: string  Mail (header) content Returns: mixed If "X-Typo3MID" header is found and integrity is OK, then an array with 'mid', 'rtbl' and 'rid' keys are returned. Otherwise void. Definition at line 142 of file class.t3lib_readmail.php. References $out. { 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); } } }

t3lib_readmail::getCType (  $  str  )

Returns Content Type plus more. Obsolete, use fullParse() Parameters: string  "ContentType" string with more Returns: array parts in key/value pairs Definition at line 248 of file class.t3lib_readmail.php. Referenced by getMessage(). { $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; }

t3lib_readmail::getMailBoundaryParts (  $  boundary, $  content )

Splits the body of a mail into parts based on the boundary string given. Obsolete, use fullParse() Parameters: string  Boundary string used to split the content. string  BODY section of a mail Returns: array Parts of the mail based on this Definition at line 228 of file class.t3lib_readmail.php. Referenced by getMessage(). { $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; }

t3lib_readmail::getMessage (  $  mailParts  )

Returns the text content of a mail which has previously been parsed by eg. extractMailHeader() Probably obsolete since the function fullParse() is more advanced and safer to use. Parameters: array  Output from extractMailHeader() Returns: string The content. Definition at line 188 of file class.t3lib_readmail.php. References getCType(), getMailBoundaryParts(), and getTextContent(). { 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; }

t3lib_readmail::getTextContent (  $  content  )

Returns the body part of a raw mail message (including headers) Probably obsolete since the function fullParse() is more advanced and safer to use. Parameters: string  Raw mail content Returns: string Body of message Definition at line 213 of file class.t3lib_readmail.php. Referenced by getMessage(). { $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']; }

---

Member Data Documentation

t3lib_readmail::$dateAbbrevs

Initial value: 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 ) Definition at line 88 of file class.t3lib_readmail.php.

t3lib_readmail::$serverGMToffsetMinutes = 60

Definition at line 102 of file class.t3lib_readmail.php.

---

The documentation for this class was generated from the following file:

• t3lib/class.t3lib_readmail.php

---