[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/externals/mimemailparser/ -> MimeMailParser.class.php (summary)

(no description)

File Size: 459 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 externals/mimemailparser/attachment.class.php

Defines 1 class

MimeMailParser:: (24 methods):
  __construct()
  __destruct()
  setPath()
  setStream()
  setText()
  parse()
  getHeaders()
  getHeadersRaw()
  getHeader()
  getMessageBody()
  getMessageBodyHeaders()
  getAttachments()
  getPartHeaders()
  getPartHeader()
  getPartContentType()
  getPartContentDisposition()
  getPartHeaderRaw()
  getPartBody()
  getPartHeaderFromFile()
  getPartBodyFromFile()
  getPartHeaderFromText()
  getPartBodyFromText()
  getAttachmentStream()
  decode()


Class: MimeMailParser  - X-Ref

Fast Mime Mail parser Class using PHP's MailParse Extension

__construct()   X-Ref
Inialize some stuff

return:

__destruct()   X-Ref
Free the held resouces

return: void

setPath($path)   X-Ref
Set the file path we use to get the email text

param: $mail_path Object
return: Object MimeMailParser Instance

setStream($stream)   X-Ref
Set the Stream resource we use to get the email text

param: $stream Resource
return: Object MimeMailParser Instance

setText($data)   X-Ref
Set the email text

param: $data String
return: Object MimeMailParser Instance

parse()   X-Ref
Parse the Message into parts

return: void

getHeaders()   X-Ref
Retrieve the Email Headers

return: Array

getHeadersRaw()   X-Ref
Retrieve the raw Email Headers

return: string

getHeader($name)   X-Ref
Retrieve a specific Email Header

param: $name String Header name
return: String

getMessageBody($type = 'text')   X-Ref
Returns the email message body in the specified format

param: $type Object[optional]
return: Mixed String Body or False if not found

getMessageBodyHeaders($type = 'text')   X-Ref
get the headers for the message body part.

param: $type Object[optional]
return: Array

getAttachments()   X-Ref
Returns the attachments contents in order of appearance

param: $type Object[optional]
return: Array

getPartHeaders($part)   X-Ref
Return the Headers for a MIME part

param: $part Array
return: Array

getPartHeader($part, $header)   X-Ref
Return a Specific Header for a MIME part

param: $part Array
param: $header String Header Name
return: Array

getPartContentType($part)   X-Ref
Return the ContentType of the MIME part

param: $part Array
return: String

getPartContentDisposition($part)   X-Ref
Return the Content Disposition

param: $part Array
return: String

getPartHeaderRaw(&$part)   X-Ref
Retrieve the raw Header of a MIME part

param: $part Object
return: String

getPartBody(&$part)   X-Ref
Retrieve the Body of a MIME part

param: $part Object
return: String

getPartHeaderFromFile(&$part)   X-Ref
Retrieve the Header from a MIME part from file

param: $part Array
return: String Mime Header Part

getPartBodyFromFile(&$part)   X-Ref
Retrieve the Body from a MIME part from file

param: $part Array
return: String Mime Body Part

getPartHeaderFromText(&$part)   X-Ref
Retrieve the Header from a MIME part from text

param: $part Array
return: String Mime Header Part

getPartBodyFromText(&$part)   X-Ref
Retrieve the Body from a MIME part from text

param: $part Array
return: String Mime Body Part

getAttachmentStream(&$part)   X-Ref
Read the attachment Body and save temporary file resource

param: $part Array
return: String Mime Body Part

decode($encodedString, $encodingType)   X-Ref
Decode the string depending on encoding type.

param: $encodedString    The string in its original encoded state.
param: $encodingType     The encoding type from the Content-Transfer-Encoding header of the part.
return: String the decoded string.



Generated: Sun Nov 30 09:20:46 2014 Cross-referenced by PHPXref 0.7.1