MailinglistMessagePart A class to represent a piece of a email message. More...

Inheritance diagram for MailinglistMessagePart:

Public Member Functions
	headerRaw ($name)
	headerRaw(). More...

	header ($name)
	header() More...

	headerEmail ($name)
	Return header parsed as an email address into an array with indexes email and name. More...

	headerNoComments ($name)

	addHeader ($header_name, $header_value)
	Add a given header to the message, if header already exists, add as an array. More...

	setHeader ($header_name, $header_value)
	Set a header to a given value. More...

	body ()
	Return the body of the message. More...

	headers ()
	Return array of all headers. More...

	__construct ($msg=NULL)
	Build an message part. More...

	parseHeaders ()
	parseHeaders() Converts the headers member from a single text string with the contents of the part (or message) headers to an associtive array of the headers. More...

	parseBody ()
	parseBody()) converts text string in the body variable into a processed body For MIME type multipart, the body will become an array of the sections For MIME type message/rfc822, the body will become a MailingMessage object More...

	parseEmailAddr ($addr)
	Parse an Email address. More...

	stripComments ($header)

	logError ($str, $parm=array())
	logError() More...

Data Fields
	$headers
	An array of the headers of the message part Header name is the index to the array. More...

	$body
	The body of the message, if it is a multi-part then it is an array of the various multi-parts. More...

Detailed Description

MailinglistMessagePart A class to represent a piece of a email message.

Definition at line 268 of file MailinglistMessage.class.php.

Constructor & Destructor Documentation

__construct ( $msg = NULL )

Build an message part.

Parameters

$msg	The data to build the message from. Expecting a string with the data to build the part

Returns: Build the MailinglistMessagePart

Definition at line 402 of file MailinglistMessage.class.php.

References body(), headers(), parseBody(), and parseHeaders().

                                     {
     if (is_string($msg)) {
       $break = strpos($msg, "\n\n");
       $this->headers = substr($msg, 0, $break+1);
       $this->body = substr($msg, $break+2);
 
       $this->parseHeaders();
       $this->parseBody();
     }
   }

Here is the call graph for this function:

Member Function Documentation

addHeader	(	$header_name,
		$header_value
	)

Add a given header to the message, if header already exists, add as an array.

Definition at line 352 of file MailinglistMessage.class.php.

References headers().

Referenced by parseHeaders().

                                                   {
     if (is_array($header_value)) {
       // if given an array, add each element
       foreach ($header_value as $value) {
         $this->addHeader($header_name, $value);
       }
     }
     else {
       $header_value = trim($header_value);
     // duplicate headers become arrays
       if (isset($this->headers[$header_name])) {
         if (!is_array($this->headers[$header_name])) {
           $this->headers[$header_name] = array($this->headers[$header_name]);
         }
         $this->headers[$header_name][] = $header_value;
       }
       else {
         $this->headers[$header_name] = $header_value;
       }
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

body ( )

Return the body of the message.

Definition at line 384 of file MailinglistMessage.class.php.

References $body.

Referenced by __construct(), and parseBody().

                   {
     return $this->body;
   }

Here is the caller graph for this function:

header ( $name )

header()

Retrieves a specifed header from the message, performing general conversions on the data. This presumes that we will not be parsing the header latter for atoms.

Parameters

$name String with the name of the header to get.

Returns: the value of the header (a string or an array if multiple headers of that type).

Definition at line 307 of file MailinglistMessage.class.php.

References headerRaw(), and mailinglist_message_rfc2047().

Referenced by headerNoComments().

                          {
     $header = $this->headerRaw($name);
     $header = mailinglist_message_rfc2047($header);
 
     return $header;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

headerEmail ( $name )

Return header parsed as an email address into an array with indexes email and name.

Definition at line 318 of file MailinglistMessage.class.php.

References headerRaw(), and parseEmailAddr().

                               {
     $name = $this->headerRaw($name);
     if (is_array($name)) {
       $result = array();
       foreach ($name as $key => $data) {
         $result[$key] = parseEmailAddr($data);
       }
     }
     else {
       $result = $this->parseEmailAddr($name);
     }
 
     return $result;
   }

Here is the call graph for this function:

headerNoComments ( $name )

Definition at line 336 of file MailinglistMessage.class.php.

References header(), and stripComments().

                                    {
     $header = $this->header($name);
     if (is_array($header)) {
       foreach($header as $key => $data) {
         $result[$key] = $this->stripComments($data);
       }
     }
     else {
       $result = $this->stripComments($header);
     }
     return $result;
   }

Here is the call graph for this function:

headerRaw ( $name )

headerRaw().

Get raw header.

Parameters

$name String with the name of the header to get.

Returns: the value of the header (a string or an array if multiple headers of that type).

Definition at line 290 of file MailinglistMessage.class.php.

References headers().

Referenced by header(), and headerEmail().

                             {
     if (isset($this->headers[$name])) {
       return $this->headers[$name];
     }
     else return FALSE;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

headers ( )

Return array of all headers.

Definition at line 391 of file MailinglistMessage.class.php.

References $headers.

Referenced by __construct(), addHeader(), headerRaw(), parseBody(), parseHeaders(), and setHeader().

                      {
     return $this->headers;
   }

Here is the caller graph for this function:

logError	(	$str,
		$parm = `array()`
	)

logError()

Log a error

Definition at line 663 of file MailinglistMessage.class.php.

Referenced by parseBody(), and parseHeaders().

                                            {
     dpm($str, NULL, 'error');
     watchdog('MailinglistMessage', $str, $parms, WATCHDOG_ERROR);
   }

Here is the caller graph for this function:

parseBody ( )

parseBody()) converts text string in the body variable into a processed body For MIME type multipart, the body will become an array of the sections For MIME type message/rfc822, the body will become a MailingMessage object

Process encoding, character sets to make data stored as UTF-8 Thus the encoding/character set do NOT represent what is in the buffer, but how the data was sent.

Notes: Content-Type: Text/plain multipart/mixed multipart/alternate multipart/digest charset= US-ASCII UTF-8 ISO-8859-#

Content-Transfer-Encoding: BASE64, Quoted-printable, 7bit, 8bit

Todo:: we may want to somehow special mark text/plain sections?

Definition at line 525 of file MailinglistMessage.class.php.

References $body, body(), headers(), and logError().

Referenced by __construct().

                        {
 
     if (isset($this->headers['Content-Transfer-Encoding'])) {
       $header = new MailinglistHeader($this->headers['Content-Transfer-Encoding']);
       $cte = $header->get_atom();
 
       switch (strtolower($cte)) {
         case 'quoted-printable':
           $this->body = quoted_printable_decode($this->body);
           break;
         case 'base64':
           $this->body = base64_decode($this->body);
           break;
         default:
           $this->logError('Unknown CTE "@cte"', array('@cte' => $cte));
         case 'binary':
         case '8bit':
         case '7bit':
           // These encodings use a null transform, so we can ignore them
           break;
       }
     }
     else {
       $cte = '7bit';
     }
 
     if (isset($this->headers['Content-Type'])) {
       $header = new MailinglistHeader($this->headers['Content-Type']);
       $ct = $header->get_atom();
       $pos = strpos($ct, '/');
       if (!$pos) {
         $this->logError('Bad Content-Type Format', $ct);
         $pos = 0;
       }
       $type = substr($ct, 0, $pos);
       $subtype = substr($ct, $pos+1);
       $header->get_char();  // Remove the terminator (;) on the atom.
       $parms = array();
       // Get parameters to Content-Type
       while ($parm = $header->get_token()) {
         $char = $header->get_char(); // eat the =
         $value = $header->get_value();
         $parms[$parm] = $value;
       }
       switch (strtolower($type)) {
         case 'multipart':
           $bodies = explode("--" . $parms['boundary'], $this->body);
           $this->body = array();
           foreach ($bodies as $body) {
             if (!empty($body) && $body[0] == "\n" && strlen($body) > 2) {
               $this->body[] = new MailinglistMessagePart(substr($body, 1));
             }
           }
           break;
         case 'message':
           if ($subtype == 'rfc822') {
             $this->body = new MailinglistMessage($this->body);
           }
           break;
 
         case 'text':
           if (isset($parms['charset'])) {
             $charset = strtoupper($parms['charset']);
             if ($charset == 'US-ASCII') $charset = 'ASCII';
             $encodings = mb_list_encodings();
             $this->body = mb_convert_encoding($this->body, 'UTF-8', $charset);
           }
           break;
 
         default:
           $this->logError('Unkown Content Type ' . $type . ' / ' . $subtype);
           dpm(array($type, $subtype));
       }
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

parseEmailAddr ( $addr )

Parse an Email address.

Parameters

$addr The email address to parse

Returns: array ['email'] = email address ['name'] = the name associated with it.

Todo:: this is a bit too simple in parsing.

Definition at line 609 of file MailinglistMessage.class.php.

Referenced by headerEmail().

                                  {
     $pos = strpos($addr, '<');
     if ($pos !== FALSE) {
       // Address uses name <email> format.
       $pos1 = strpos($addr, '>', $pos);
       $email = substr($addr, $pos+1, $pos1-$pos-2);
       if ($pos > 0) {
         $name = substr($addr, 0, $pos) . substr($addr, $pos1+1);
       }
       else {
         $name = substr($addr, $pos1+1);
       }
     }
     else {
       $pos = strpos($addr, '(');
       if ($pos !== FALSE) {
         $pos1 = strpos($addr, ')');
         $name = substr($addr, $pos+1, $pos1-$pos-1);
         if ($pos > 0) {
           $email = substr($addr, 0, $pos) . substr($addr, $pos1+1);
         }
         else {
           $email = substr($addr, $pos1+1);
         }
       }
       else {
         $email = $addr;
         $name = "";
       }
     }
 
     return array('email' => trim($email), 'name' => trim($name));
   }

Here is the caller graph for this function:

parseHeaders ( )

parseHeaders() Converts the headers member from a single text string with the contents of the part (or message) headers to an associtive array of the headers.

The index of the array is the Header name, and the value is the header value. If header was repeated, the value will be an array with each header as an element.

Todo:: make header character fix better

Definition at line 420 of file MailinglistMessage.class.php.

References $headers, addHeader(), headers(), and logError().

Referenced by __construct().

                           {
     // Fix any character problems. If real email message, should only be ascii,
     // but some mbox files will have been converted, see if UTF or ISO-8859
 
     $charset = "";
     @$headers = iconv('UTF-8//IGNORE', 'UTF-8', $this->headers);
     if ($headers != $this->headers) {
       $headers = iconv('ISO-8859-1//IGNORE', 'UTF-8', $this->headers);
       $charset = 'ISO-8859-1';
     }
 
     // Unfold headers newline-whitespace => space
     $headers = preg_replace('/\n\s+/', ' ', $headers);
     // Convert to an array of headers
     $headers = explode("\n", $headers);
     // Build up the associative array of the headers
     $this->headers = array();
     if(!empty($charset)){
       $this->addHeader('XX-HeaderCharset', $charset);
     }
     foreach ($headers as $header) {
       $colon = strpos($header, ': ');
       if ($colon > 0) {
         $header_name = substr($header, 0, $colon);
         $header_value = substr($header, $colon+2);
 
         switch ($header_name) {
           case 'References':
             $header_value = str_replace("\t", " ", $header_value);
             $header_value = str_replace('><', '> <', $header_value);
             $header_value = explode(' ', $header_value);
             break;
           case 'To':
           case 'Cc':
           case 'From':
           case 'Reply-To':
             $pos = 0;
             // See if there is a comma to process, start at beginning
             while( FALSE !== ($posc = strpos($header_value, ',', $pos))){
               $pos1 = strpos($header_value, '(', $pos);
               $pos2 = strpos($header_value, '<', $pos);
               $pos3 = strpos($header_value, '\\', $pos);
               $pos4 = strpos($header_value, '"', $pos);
               if($pos1 === FALSE) $pos1 = $posc;
               if($pos2 === FALSE) $pos2 = $posc;
               if($pos3 === FALSE) $pos3 = $posc;
               if($pos4 === FALSE) $pos4 = $posc;
               $pos1 = min($pos1, $pos2, $pos3, $pos4);
               if($pos1 < $posc) {
                 switch($header_value[$pos1]) {
                   case '(':
                     $pos = strpos($header_value, ')', $pos1);
                     if(!$pos) $pos = $pos1+1;
                     break;
                   case '<':
                     $pos = strpos($header_value, '>', $pos1);
                     if(!$pos) $pos = $pos1+1;
                     break;
                   case '\\':
                     $pos = $pos1+2;
                     break;
                   case '"':
                     $pos = strpos($header_value, '"', $pos1+1);
                     if(!$pos) $pos = $pos1+1;
                     break;
                   default:
                     $this->logError('Error Processing Header: ' . $header_value);
                     break;
                 }
               }
               else {
                 // All quotes are after the comma, so process it.
                 $value = substr($header_value, 0, $posc);
                 $this->addHeader($header_name, $value);
                 // Strip out value, and process after the ,
                 $header_value = substr($header_value, $posc+1);
                 $pos = 0;
               }
             }
           default:
             break;
         }
         $this->addHeader($header_name, $header_value);
       }
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

setHeader	(	$header_name,
		$header_value
	)

Set a header to a given value.

Definition at line 377 of file MailinglistMessage.class.php.

References headers().

Referenced by MailinglistMessage\__construct().

                                                   {
     $this->headers[$header_name] = $header_value;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

stripComments ( $header )

Definition at line 644 of file MailinglistMessage.class.php.

Referenced by headerNoComments().

                                   {
     while(FALSE !== ($pos = strpos($header, '('))) {
       $pos1 = strpos($header, ')', $pos);
       if($pos1 != FALSE) {
         $header = substr($header, 0, $pos) . ' ' . substr($header, $pos1+1);
       }
       else {
         // badly formated, strip rest of header
         $header = substr($header, 0, $pos);
       }
     }
     return $header;
   }