API Documentation

Mime/Part.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: Part.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Mime_Part

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_Part

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
Properties
$type
$encoding
$id
$disposition
$filename
$description
$charset
$boundary
$location
$language
$_content
$_isStream
Methods
__construct
isStream
getEncodedStream
getContent
getHeadersArray
getHeaders

Description

Class representing a MIME part.

Properties

$_content

 $_content = ''

Details

visibility
protected
default
final
false
static
false

$_isStream

 $_isStream = 'false'

Details

visibility
protected
default
false
final
false
static
false

$boundary

 $boundary = ''

Details

visibility
public
default
final
false
static
false

$charset

 $charset = ''

Details

visibility
public
default
final
false
static
false

$description

 $description = ''

Details

visibility
public
default
final
false
static
false

$disposition

 $disposition = ''

Details

visibility
public
default
final
false
static
false

$encoding

 $encoding = 'Zend_Mime'

Details

visibility
public
default
Zend_Mime
final
false
static
false

$filename

 $filename = ''

Details

visibility
public
default
final
false
static
false

$id

 $id = ''

Details

visibility
public
default
final
false
static
false

$language

 $language = ''

Details

visibility
public
default
final
false
static
false

$location

 $location = ''

Details

visibility
public
default
final
false
static
false

$type

 $type = 'Zend_Mime'

Details

visibility
public
default
Zend_Mime
final
false
static
false

Methods

__construct

__construct( mixed $content ) :

create a new Mime Part.

The (unencoded) content of the Part as passed as a string or stream

Arguments
$content
mixed
String or Stream containing the content
Details
visibility
public
final
false
static
false

getContent

getContent(  $EOL = Zend_Mime ) : String

Get the Content of the current Mime Part in the given encoding.

Arguments
$EOL
Output
String
Details
visibility
public
final
false
static
false

getEncodedStream

getEncodedStream( ) : stream

if this was created with a stream, return a filtered stream for reading the content. very useful for large file attachments.

Output
stream
Details
visibility
public
final
false
static
false
throws
if not a stream or unable to append filter

getHeaders

getHeaders(  $EOL = Zend_Mime ) : String

Return the headers for this part as a string

Arguments
$EOL
Output
String
Details
visibility
public
final
false
static
false

getHeadersArray

getHeadersArray(  $EOL = Zend_Mime ) : array

Create and return the array of headers for this MIME part

Arguments
$EOL
Output
array
Details
visibility
public
final
false
static
false
access
public

isStream

isStream( ) : bool

check if this part can be read as a stream.

if true, getEncodedStream can be called, otherwise only getContent can be used to fetch the encoded content of the part

Output
bool
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.