API Documentation

Zend/Mime/Part.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mime  
Version
$Id: Part.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mime_Part

Package: Zend\Mime

Class representing a MIME part.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_content= ''
Details
Type
Propertyprotected  $_isStream= 'false'
Default valuefalseDetails
Type
Propertypublic  $boundary= ''
Details
Type
Propertypublic  $charset= ''
Details
Type
Propertypublic  $description= ''
Details
Type
Propertypublic  $disposition= ''
Details
Type
Propertypublic  $encoding= 'Zend_Mime::ENCODING_8BIT'
Default valueZend_Mime::ENCODING_8BITDetails
Type
Propertypublic  $filename= ''
Details
Type
Propertypublic  $id= ''
Details
Type
Propertypublic  $language= ''
Details
Type
Propertypublic  $location= ''
Details
Type
Propertypublic  $type= 'Zend_Mime::TYPE_OCTETSTREAM'
Default valueZend_Mime::TYPE_OCTETSTREAMDetails
Type

Methods

methodpublic__construct( mixed $content ) : void

create a new Mime Part.

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

Parameters
Name Type Description
$content mixed

String or Stream containing the content

methodpublicgetContent(  $EOL = Zend_Mime::LINEEND ) : String

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

Parameters
Name Type Description
$EOL
Returns
Type Description
String
methodpublicgetEncodedStream( ) : \stream

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

Returns
Type Description
\stream
Throws
Exception Description
\Zend_Mime_Exception if not a stream or unable to append filter
methodpublicgetHeaders(  $EOL = Zend_Mime::LINEEND ) : String

Return the headers for this part as a string

Parameters
Name Type Description
$EOL
Returns
Type Description
String
methodpublicgetHeadersArray(  $EOL = Zend_Mime::LINEEND ) : array

Create and return the array of headers for this MIME part

Parameters
Name Type Description
$EOL
Returns
Type Description
array
Details
Access
public  
methodpublicgetRawContent( ) : string

Get the RAW unencoded content from this part

Returns
Type Description
string
methodpublicisStream( ) : 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

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.