PHP Class PhpMimeMailParser\Parser

Fully Tested Mailparse Extension Wrapper for PHP 5.4+
Afficher le fichier Open project: exorus/php-mime-mail-parser Class Usage Examples

Protected Properties

Свойство Type Description
$charset object
$data string A text of an email
$parts array Parts of an email
$resource resource PHP MimeParser Resource ID
$stream resource A file pointer to email

Méthodes publiques

Méthode Description
__construct ( PhpMimeMailParser\Contracts\CharsetManager $charset = null ) Parser constructor.
__destruct ( ) : void Free the held resources
getAddresses ( string $name ) : array Return an array with the following keys display, address, is_group
getAttachments ( $include_inline = true ) : Attachment[] Returns the attachments contents in order of appearance
getCharset ( ) : PhpMimeMailParser\Contracts\CharsetManager Retrieve the charset manager object
getData ( ) : string Retrieve the text of an email
getHeader ( string $name ) : string Retrieve a specific Email Header
getHeaders ( ) : array Retrieve all mail headers
getHeadersRaw ( ) : string Retrieve the raw mail headers as a string
getMessageBody ( string $type = 'text' ) : false | string Returns the email message body in the specified format
getParts ( ) : array Retrieve the parts of an email
getRawHeader ( string $name ) : string Retrieve a specific Email Header, without charset conversion.
getResource ( ) : resource Retrieve the resource
getStream ( ) : resource Retrieve the file pointer to email
saveAttachments ( string $attach_dir, $include_inline = true ) : array Save attachments in a folder
setPath ( string $path ) : Parser Set the file path we use to get the email text
setStream ( resource $stream ) : Parser Set the Stream resource we use to get the email text
setText ( string $data ) : Parser Set the email text

Méthodes protégées

Méthode Description
decodeContentTransfer ( string $encodedString, string $encodingType ) : string Decode the string from Content-Transfer-Encoding
decodeHeader ( string | array $input ) : string $input can be a string or array
decodeSingleHeader ( string $input ) : string Decodes a single header (= string)
getAttachmentStream ( array &$part ) : resource Read the attachment Body and save temporary file resource
getEmbeddedData ( string $contentId ) : string Returns the embedded data structure
getPart ( string $type, array $parts ) : string | array Retrieve a specified MIME part
getPartBody ( array &$part ) : string Retrieve the Body of a MIME part
getPartBodyFromFile ( array &$part ) : string Retrieve the Body from a MIME part from file
getPartBodyFromText ( array &$part ) : string Retrieve the Body from a MIME part from text
getPartCharset ( array $part ) : string | false Return the charset of the MIME part
getPartComplete ( array &$part ) : string Retrieve the content of a MIME part
getPartFromFile ( array &$part ) : string Retrieve the content from a MIME part from file
getPartFromText ( array &$part ) : string Retrieve the content from a MIME part from text
getPartHeader ( &$part ) : String Retrieve the raw Header of a MIME part
getPartHeaderFromFile ( &$part ) : String Retrieve the Header from a MIME part from file
getPartHeaderFromText ( &$part ) : String Retrieve the Header from a MIME part from text
parse ( ) : void Parse the Message into parts

Method Details

__construct() public méthode

Parser constructor.
public __construct ( PhpMimeMailParser\Contracts\CharsetManager $charset = null )
$charset PhpMimeMailParser\Contracts\CharsetManager

__destruct() public méthode

Free the held resources
public __destruct ( ) : void
Résultat void

decodeContentTransfer() protected méthode

Decode the string from Content-Transfer-Encoding
protected decodeContentTransfer ( string $encodedString, string $encodingType ) : string
$encodedString string The string in its original encoded state
$encodingType string The encoding type from the Content-Transfer-Encoding header of the part.
Résultat string The decoded string

decodeHeader() protected méthode

$input can be a string or array
protected decodeHeader ( string | array $input ) : string
$input string | array
Résultat string

decodeSingleHeader() protected méthode

Decodes a single header (= string)
protected decodeSingleHeader ( string $input ) : string
$input string
Résultat string

getAddresses() public méthode

Return an array with the following keys display, address, is_group
public getAddresses ( string $name ) : array
$name string Header name (case-insensitive)
Résultat array

getAttachmentStream() protected méthode

Read the attachment Body and save temporary file resource
protected getAttachmentStream ( array &$part ) : resource
$part array
Résultat resource Mime Body Part

getAttachments() public méthode

Returns the attachments contents in order of appearance
public getAttachments ( $include_inline = true ) : Attachment[]
Résultat Attachment[]

getCharset() public méthode

Retrieve the charset manager object
public getCharset ( ) : PhpMimeMailParser\Contracts\CharsetManager
Résultat PhpMimeMailParser\Contracts\CharsetManager charset

getData() public méthode

Retrieve the text of an email
public getData ( ) : string
Résultat string data

getEmbeddedData() protected méthode

Returns the embedded data structure
protected getEmbeddedData ( string $contentId ) : string
$contentId string Content-Id
Résultat string

getHeader() public méthode

Retrieve a specific Email Header
public getHeader ( string $name ) : string
$name string Header name (case-insensitive)
Résultat string

getHeaders() public méthode

Retrieve all mail headers
public getHeaders ( ) : array
Résultat array

getHeadersRaw() public méthode

Retrieve the raw mail headers as a string
public getHeadersRaw ( ) : string
Résultat string

getMessageBody() public méthode

Returns the email message body in the specified format
public getMessageBody ( string $type = 'text' ) : false | string
$type string text, html or htmlEmbedded
Résultat false | string Body or False if not found

getPart() protected méthode

Retrieve a specified MIME part
protected getPart ( string $type, array $parts ) : string | array
$type string
$parts array
Résultat string | array

getPartBody() protected méthode

Retrieve the Body of a MIME part
protected getPartBody ( array &$part ) : string
$part array
Résultat string

getPartBodyFromFile() protected méthode

Retrieve the Body from a MIME part from file
protected getPartBodyFromFile ( array &$part ) : string
$part array
Résultat string Mime Body Part

getPartBodyFromText() protected méthode

Retrieve the Body from a MIME part from text
protected getPartBodyFromText ( array &$part ) : string
$part array
Résultat string Mime Body Part

getPartCharset() protected méthode

Return the charset of the MIME part
protected getPartCharset ( array $part ) : string | false
$part array
Résultat string | false

getPartComplete() protected méthode

Retrieve the content of a MIME part
protected getPartComplete ( array &$part ) : string
$part array
Résultat string

getPartFromFile() protected méthode

Retrieve the content from a MIME part from file
protected getPartFromFile ( array &$part ) : string
$part array
Résultat string Mime Content

getPartFromText() protected méthode

Retrieve the content from a MIME part from text
protected getPartFromText ( array &$part ) : string
$part array
Résultat string Mime Content

getPartHeader() protected méthode

Retrieve the raw Header of a MIME part
protected getPartHeader ( &$part ) : String
$part Object
Résultat String

getPartHeaderFromFile() protected méthode

Retrieve the Header from a MIME part from file
protected getPartHeaderFromFile ( &$part ) : String
$part Array
Résultat String Mime Header Part

getPartHeaderFromText() protected méthode

Retrieve the Header from a MIME part from text
protected getPartHeaderFromText ( &$part ) : String
$part Array
Résultat String Mime Header Part

getParts() public méthode

Retrieve the parts of an email
public getParts ( ) : array
Résultat array parts

getRawHeader() public méthode

Retrieve a specific Email Header, without charset conversion.
public getRawHeader ( string $name ) : string
$name string Header name (case-insensitive)
Résultat string

getResource() public méthode

Retrieve the resource
public getResource ( ) : resource
Résultat resource resource

getStream() public méthode

Retrieve the file pointer to email
public getStream ( ) : resource
Résultat resource stream

parse() protected méthode

Parse the Message into parts
protected parse ( ) : void
Résultat void

saveAttachments() public méthode

Save attachments in a folder
public saveAttachments ( string $attach_dir, $include_inline = true ) : array
$attach_dir string directory
Résultat array Saved attachments paths

setPath() public méthode

Set the file path we use to get the email text
public setPath ( string $path ) : Parser
$path string File path to the MIME mail
Résultat Parser MimeMailParser Instance

setStream() public méthode

Set the Stream resource we use to get the email text
public setStream ( resource $stream ) : Parser
$stream resource
Résultat Parser MimeMailParser Instance

setText() public méthode

Set the email text
public setText ( string $data ) : Parser
$data string
Résultat Parser MimeMailParser Instance

Property Details

$charset protected_oe property

object
protected $charset

$data protected_oe property

A text of an email
protected string $data
Résultat string

$parts protected_oe property

Parts of an email
protected array $parts
Résultat array

$resource protected_oe property

PHP MimeParser Resource ID
protected resource $resource
Résultat resource

$stream protected_oe property

A file pointer to email
protected resource $stream
Résultat resource