API Documentation

Mail/Part/Interface.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Mail  
subpackage
Storage  
version
$Id: Interface.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Mail_Part_Interface

Extends from
\RecursiveIterator
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Mail  
subpackage
Storage  

Methods

methodpublic__get( string $name ) : string

Getter for mail headers - name is matched in lowercase

This getter is short for Zend_Mail_Part::getHeader($name, 'string')

Parameters
Name Type Description
$name string header name
Returns
Type Description
string value of header
Throws
Exception Description
\Zend_Mail_Exception
Details
see
\Zend_Mail_Part::getHeader()  
methodpublic__toString( ) : string

magic method to get content of part

Returns
Type Description
string content
methodpubliccountParts( ) : int

Count parts of a multipart part

Returns
Type Description
int number of sub-parts
methodpublicgetContent( ) : string

Body of part

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

Returns
Type Description
string body
Throws
Exception Description
\Zend_Mail_Exception
methodpublicgetHeader( string $name, string $format = null ) : string|array

Get a header in specificed format

Internally headers that occur more than once are saved as array, all other as string. If $format is set to string implode is used to concat the values (with Zend_Mime::LINEEND as delim).

Parameters
Name Type Description
$name string

name of header, matches case-insensitive, but camel-case is replaced with dashes

$format string

change type of return value to 'string' or 'array'

Returns
Type Description
stringarray value of header in wanted or internal format
Throws
Exception Description
\Zend_Mail_Exception
methodpublicgetHeaderField( string $name, string $wantedPart = 0, string $firstName = 0 ) : string|array

Get a specific field from a header like content type or all fields as array

If the header occurs more than once, only the value from the first header is returned.

Throws a Zend_Mail_Exception if the requested header does not exist. If the specific header field does not exist, returns null.

Parameters
Name Type Description
$name string

name of header, like in getHeader()

$wantedPart string the wanted part, default is first, if null an array with all parts is returned
$firstName string key name for the first part
Returns
Type Description
stringarray wanted part or all parts as array($firstName => firstPart, partname => value)
Throws
Exception Description
\Zend_Exception, Zend_Mail_Exception
methodpublicgetHeaders( ) : array

Get all headers

The returned headers are as saved internally. All names are lowercased. The value is a string or an array if a header with the same name occurs more than once.

Returns
Type Description
array headers as array(name => value)
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

Returns
Type Description
int size
methodpublicisMultipart( ) : bool

Check if part is a multipart message

Returns
Type Description
bool if part is multipart
Documentation was generated by DocBlox 0.13.3.