phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Class: mime_parser_class

Source Location: /qp_inc/_ext/mime_parser/mime_parser.php

Class mime_parser_class

Class Overview

{metadocument}<?xml version="1.0" encoding="ISO-8859-1" ?> <class>

<package>net.manuellemos.mimeparser</package>

<copyright>Copyright (C) Manuel Lemos 2006</copyright> <title>MIME parser</title> <author>Manuel Lemos</author> <authoraddress>mlemos-at-acm.org</authoraddress>

<documentation> <idiom>en</idiom> <purpose>Parse MIME encapsulated e-mail message data compliant with the RFC 2822 or aggregated in mbox format.</purpose> <usage>Use the function <functionlink>Decode</functionlink> function to retrieve the structure of the messages to be parsed. Adjust its parameters to tell how to return the decoded body data. Use the <tt>SaveBody</tt> parameter to make the body parts be saved to files when the message is larger than the available memory. Use the <tt>SkipBody</tt> parameter to just retrieve the message structure without returning the body data.<paragraphbreak /> If the message data is an archive that may contain multiple messages aggregated in the mbox format, set the variable <variablelink>mbox</variablelink> to <booleanvalue>1</booleanvalue>.</usage> </documentation>

{/metadocument}

Located in /qp_inc/_ext/mime_parser/mime_parser.php [line 103]



		
		
		
		

Properties

Methods

[ Top ]
Property Summary
mixed   $address_headers  
mixed   $body_buffer  
mixed   $body_buffer_position  
mixed   $body_file  
mixed   $body_offset  
mixed   $body_parser  
mixed   $body_parser_state  
mixed   $body_part_number  
mixed   $buffer  
mixed   $buffer_position  
mixed   $current_header  
mixed   $decode_bodies  
mixed   $decode_headers  
mixed   $error  
mixed   $error_position  
mixed   $extract_addresses  
mixed   $file  
mixed   $headers  
mixed   $ignore_syntax_errors  
mixed   $mbox  
mixed   $next_token  
mixed   $offset  
mixed   $parts  
mixed   $part_position  
mixed   $position  
mixed   $state  
mixed   $warnings  

[ Top ]
Method Summary
void   Analyze()   dummy docblock makes error-free autodocs
void   CopyAddresses()   dummy docblock makes error-free autodocs
void   Decode()   dummy docblock makes error-free autodocs
void   DecodePart()   dummy docblock makes error-free autodocs
void   DecodeStream()   dummy docblock makes error-free autodocs
void   FindBodyLineBreak()   dummy docblock makes error-free autodocs
void   FindLineBreak()   dummy docblock makes error-free autodocs
void   FindStringLineBreak()   dummy docblock makes error-free autodocs
void   GetPart()   dummy docblock makes error-free autodocs
void   Parse()   dummy docblock makes error-free autodocs
void   ParseFile()   dummy docblock makes error-free autodocs
void   ParseHeaderString()   dummy docblock makes error-free autodocs
void   ParseParameters()   dummy docblock makes error-free autodocs
void   ParsePart()   dummy docblock makes error-free autodocs
void   ParseStructuredHeader()   dummy docblock makes error-free autodocs
void   QueueBodyParts()   dummy docblock makes error-free autodocs
void   ReadMessageBody()   dummy docblock makes error-free autodocs
void   ResetParserState()   dummy docblock makes error-free autodocs
void   SetError()   dummy docblock makes error-free autodocs
void   SetErrorWithContact()   dummy docblock makes error-free autodocs
void   SetPHPError()   dummy docblock makes error-free autodocs
void   SetPositionedError()   dummy docblock makes error-free autodocs
void   SetPositionedWarning()   dummy docblock makes error-free autodocs
void   Tokenize()   dummy docblock makes error-free autodocs

[ Top ]
Properties
mixed   $address_headers = array(
'from:' => 1,
'to:' => 1,
'cc:' => 1,
'bcc:' => 1,
'return-path:'=>1,
'reply-to:'=>1,
'disposition-notification-to:'=>1
)
[line 258]

[ Top ]
mixed   $body_buffer = '' [line 321]

[ Top ]
mixed   $body_buffer_position = 0 [line 322]

[ Top ]
mixed   $body_file [line 326]

[ Top ]
mixed   $body_offset = 0 [line 323]

[ Top ]
mixed   $body_parser [line 319]

[ Top ]
mixed   $body_parser_state = MIME_PARSER_BODY_DONE [line 320]

[ Top ]
mixed   $body_part_number = 1 [line 328]

[ Top ]
mixed   $buffer = '' [line 313]

[ Top ]
mixed   $buffer_position = 0 [line 314]

[ Top ]
mixed   $current_header = '' [line 324]

[ Top ]
mixed   $decode_bodies = 1 [line 203]

[ Top ]
mixed   $decode_headers = 1 [line 186]

[ Top ]
mixed   $error = '' [line 130]

[ Top ]
mixed   $error_position = -1 [line 147]

[ Top ]
mixed   $extract_addresses = 1 [line 230]

[ Top ]
mixed   $file [line 325]

[ Top ]
mixed   $headers = array() [line 318]

[ Top ]
mixed   $ignore_syntax_errors = 1 [line 288]

[ Top ]
mixed   $mbox = 0 [line 169]

[ Top ]
mixed   $next_token = '' [line 329]

[ Top ]
mixed   $offset = 0 [line 315]

[ Top ]
mixed   $parts = array() [line 316]

[ Top ]
mixed   $part_position = 0 [line 317]

[ Top ]
mixed   $position = 0 [line 327]

[ Top ]
mixed   $state = MIME_PARSER_START [line 312]

[ Top ]
mixed   $warnings = array() [line 309]

[ Top ]
Methods
Analyze  [line 2008]

  void Analyze( $message, &$results  )

dummy docblock makes error-free autodocs

Parameters:
   $message: 
   &$results: 


[ Top ]
CopyAddresses  [line 1803]

  void CopyAddresses( $message, &$results, $header  )

dummy docblock makes error-free autodocs

Parameters:
   $message: 
   &$results: 
   $header: 


[ Top ]
Decode  [line 1735]

  void Decode( $parameters, &$decoded  )

dummy docblock makes error-free autodocs

Parameters:
   $parameters: 
   &$decoded: 


[ Top ]
DecodePart  [line 848]

  void DecodePart( $part  )

dummy docblock makes error-free autodocs

Parameters:
   $part: 


[ Top ]
DecodeStream  [line 1280]

  void DecodeStream( $parameters, &$end_of_message, &$decoded  )

dummy docblock makes error-free autodocs

Parameters:
   $parameters: 
   &$end_of_message: 
   &$decoded: 


[ Top ]
FindBodyLineBreak  [line 502]

  void FindBodyLineBreak( $position, &$break, &$line_break  )

dummy docblock makes error-free autodocs

Parameters:
   $position: 
   &$break: 
   &$line_break: 


[ Top ]
FindLineBreak  [line 487]

  void FindLineBreak( $position, &$break, &$line_break  )

dummy docblock makes error-free autodocs

Parameters:
   $position: 
   &$break: 
   &$line_break: 


[ Top ]
FindStringLineBreak  [line 469]

  void FindStringLineBreak( $string, $position, &$break, &$line_break  )

dummy docblock makes error-free autodocs

Parameters:
   $string: 
   $position: 
   &$break: 
   &$line_break: 


[ Top ]
GetPart  [line 1557]

  void GetPart( &$part, &$end  )

dummy docblock makes error-free autodocs

Parameters:
   &$part: 
   &$end: 


[ Top ]
Parse  [line 1496]

  void Parse( $data, $end  )

dummy docblock makes error-free autodocs

Parameters:
   $data: 
   $end: 


[ Top ]
ParseFile  [line 1529]

  void ParseFile( $file  )

dummy docblock makes error-free autodocs

Parameters:
   $file: 


[ Top ]
ParseHeaderString  [line 517]

  void ParseHeaderString( $body, &$position, &$headers  )

dummy docblock makes error-free autodocs

Parameters:
   $body: 
   &$position: 
   &$headers: 


[ Top ]
ParseParameters  [line 824]

  void ParseParameters( $value, &$first, &$parameters, $return  )

dummy docblock makes error-free autodocs

Parameters:
   $value: 
   &$first: 
   &$parameters: 
   $return: 


[ Top ]
ParsePart  [line 543]

  void ParsePart( $end, &$part, &$need_more_data  )

dummy docblock makes error-free autodocs

Parameters:
   $end: 
   &$part: 
   &$need_more_data: 


[ Top ]
ParseStructuredHeader  [line 435]

  void ParseStructuredHeader( $value, &$type, &$parameters, &$character_sets, &$languages  )

dummy docblock makes error-free autodocs

Parameters:
   $value: 
   &$type: 
   &$parameters: 
   &$character_sets: 
   &$languages: 


[ Top ]
QueueBodyParts  [line 807]

  void QueueBodyParts( )

dummy docblock makes error-free autodocs



[ Top ]
ReadMessageBody  [line 1838]

  void ReadMessageBody( $message, &$body, $prefix  )

dummy docblock makes error-free autodocs

Parameters:
   $message: 
   &$body: 
   $prefix: 


[ Top ]
ResetParserState  [line 384]

  void ResetParserState( )

dummy docblock makes error-free autodocs



[ Top ]
SetError  [line 336]

  void SetError( $error  )

dummy docblock makes error-free autodocs

Parameters:
   $error: 


[ Top ]
SetErrorWithContact  [line 345]

  void SetErrorWithContact( $error  )

dummy docblock makes error-free autodocs

Parameters:
   $error: 


[ Top ]
SetPHPError  [line 373]

  void SetPHPError( $error, &$php_error_message  )

dummy docblock makes error-free autodocs

Parameters:
   $error: 
   &$php_error_message: 


[ Top ]
SetPositionedError  [line 353]

  void SetPositionedError( $error, $position  )

dummy docblock makes error-free autodocs

Parameters:
   $error: 
   $position: 


[ Top ]
SetPositionedWarning  [line 362]

  void SetPositionedWarning( $error, $position  )

dummy docblock makes error-free autodocs

Parameters:
   $error: 
   $position: 


[ Top ]
Tokenize  [line 408]

  void Tokenize( $string, [ $separator = ""]  )

dummy docblock makes error-free autodocs

Parameters:
   $string: 
   $separator: 


[ Top ]