API Documentation

Zend/Mail/Part/File.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_Mail  
Version
$Id: File.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mail_Part_File

Package: Zend\Mail

Parent(s)
\Zend_Mail_Part
Children
\Zend_Mail_Message_File
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_contentPos= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_fh= ''
Details
Type
Propertyprotected  $_partPos= 'array()'
Default valuearray()Details
Type

Methods

methodpublic__construct( array $params ) : void

Public constructor

This handler supports the following params: - file filename or open file handler with message content (required) - startPos start position of message or part in file (default: current position) - endPos end position of message or part in file (default: end of file)

Parameters
Name Type Description
$params array

full message with or without headers

Throws
Exception Description
\Zend_Mail_Exception
methodpublicgetContent(  $stream = null ) : string

Body of part

If part is multipart the raw content of this part with all sub parts is returned

Parameters
Name Type Description
$stream
Returns
Type Description
string body
Throws
Exception Description
\Zend_Mail_Exception
methodpublicgetPart( int $num ) : \Zend_Mail_Part

Get part of multipart message

Parameters
Name Type Description
$num int

number of part starting with 1 for first part

Returns
Type Description
\Zend_Mail_Part wanted part
Throws
Exception Description
\Zend_Mail_Exception
methodpublicgetSize( ) : int

Return size of part

Quite simple implemented currently (not decoding). Handle with care.

Returns
Type Description
int size
Documentation was generated by DocBlox 0.15.1.