Mail/Part/File.php
Show:
inherited
inherited
Classes
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 [email protected] 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_Mail
- Version
- $Id$
\Zend_Mail_Part_File
Package: Zend_Mail
Throws
Returns
Throws
- Parent(s)
- \Zend_Mail_Part
- Children
- \Zend_Mail_Message_File
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
$_contentPos = array()Default value
array()Details- Type
- n/a
$_fhDetails
- Type
- n/a
$_partPos = array()Default value
array()Details- Type
- n/a
Methods
__construct(array $params) : voidPublic 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 |
| Exception | Description |
|---|---|
| \Zend_Mail_Exception |
getContent( $stream = null) : stringBody of part
If part is multipart the raw content of this part with all sub parts is returned
Parameters| Name | Type | Description |
|---|---|---|
| $stream |
| Type | Description |
|---|---|
| string | body |
| Exception | Description |
|---|---|
| \Zend_Mail_Exception |
getPart(int $num) : \Zend_Mail_PartGet part of multipart message
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $num | int | number of part starting with 1 for first part |
| Type | Description |
|---|---|
| \Zend_Mail_Part | wanted part |
| Exception | Description |
|---|---|
| \Zend_Mail_Exception |
getSize() : intReturn size of part
Quite simple implemented currently (not decoding). Handle with care.
Returns| Type | Description |
|---|---|
| int | size |