Mime/Part.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mime  
Version
$Id$  

\Zend_Mime_Part

Package: Zend_Mime
Class representing a MIME part.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_content
Details
Type
n/a
>VPropertyprotected$_isStream = false
Default valuefalseDetails
Type
n/a
>VPropertypublic$boundary
Details
Type
n/a
>VPropertypublic$charset
Details
Type
n/a
>VPropertypublic$description
Details
Type
n/a
>VPropertypublic$disposition
Details
Type
n/a
>VPropertypublic$encoding = \Zend_Mime::ENCODING_8BIT
Default value\Zend_Mime::ENCODING_8BITDetails
Type
n/a
>VPropertypublic$filename
Details
Type
n/a
>VPropertypublic$id
Details
Type
n/a
>VPropertypublic$language
Details
Type
n/a
>VPropertypublic$location
Details
Type
n/a
>VPropertypublic$type = \Zend_Mime::TYPE_OCTETSTREAM
Default value\Zend_Mime::TYPE_OCTETSTREAMDetails
Type
n/a

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
NameTypeDescription
$contentmixed

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
NameTypeDescription
$EOL
Returns
TypeDescription
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
TypeDescription
\stream
Throws
ExceptionDescription
\Zend_Mime_Exceptionif not a stream or unable to append filter
methodpublicgetHeaders( $EOL = \Zend_Mime::LINEEND) : String

Return the headers for this part as a string

Parameters
NameTypeDescription
$EOL
Returns
TypeDescription
String
methodpublicgetHeadersArray( $EOL = \Zend_Mime::LINEEND) : array

Create and return the array of headers for this MIME part

Parameters
NameTypeDescription
$EOL
Returns
TypeDescription
array
Details
Access
public  
methodpublicgetRawContent() : string

Get the RAW unencoded content from this part

Returns
TypeDescription
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
TypeDescription
bool
Documentation was generated by phpDocumentor 2.2.0 .