API Documentation

Mime/Decode.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mime
version
$Id: Decode.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Mime_Decode

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Mime_Decode

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mime
Methods
splitMime
splitMessageStruct
splitMessage
splitContentType
splitHeaderField
decodeQuotedPrintable

Description

Methods

decodeQuotedPrintable

decodeQuotedPrintable( string $string ) : string

decode a quoted printable encoded string

The charset of the returned string depends on your iconv settings.

Arguments
$string
string
encoded string
Output
string
decoded string
Details
visibility
public
final
false
static
true

splitContentType

splitContentType( string $type, string $wantedPart = null ) : string|array

split a content type in its different parts

Arguments
$type
string
content-type
$wantedPart
string
the wanted part, else an array with all parts is returned
Output
string|array
wanted part or all parts as array('type' => content-type, partname => value)
Details
visibility
public
final
false
static
true

splitHeaderField

splitHeaderField(  $field, string $wantedPart = null, string $firstName = 0 ) : string|array

split a header field like content type in its different parts

Arguments
$field
$wantedPart
string
the wanted part, else an array with all parts is returned
$firstName
string
key name for the first part
Output
string|array
wanted part or all parts as array($firstName => firstPart, partname => value)
Details
visibility
public
final
false
static
true
throws

splitMessage

splitMessage( string $message, array $headers, string $body, string $EOL = Zend_Mime ) : null

split a message in header and body part, if no header or an invalid header is found $headers is empty

The charset of the returned headers depend on your iconv settings.

Arguments
$message
string
raw message with header and optional content
$headers
array
output param, array with headers as array(name => value)
$body
string
output param, content of message
$EOL
string
EOL string; defaults to {@link Zend_Mime::LINEEND}
Output
null
Details
visibility
public
final
false
static
true

splitMessageStruct

splitMessageStruct( string $message, string $boundary, string $EOL = Zend_Mime ) : array|null

decodes a mime encoded String and returns a struct of parts with header and body

Arguments
$message
string
raw message content
$boundary
string
boundary as found in content-type
$EOL
string
EOL string; defaults to {@link Zend_Mime::LINEEND}
Output
array|null
parts as array('header' => array(name => value), 'body' => content), null if no parts found
Details
visibility
public
final
false
static
true
throws

splitMime

splitMime( string $body, string $boundary ) : array

Explode MIME multipart string into seperate parts

Parts consist of the header and the body of each MIME part.

Arguments
$body
string
raw body of message
$boundary
string
boundary as found in content-type
Output
array
parts with content of each part, empty if no parts found
Details
visibility
public
final
false
static
true
throws
Documentation was generated by DocBlox.