Mail/Part/Interface.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mail
subpackage: Storage
version: $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces: Zend_Mail_Part_Interface

Description

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.

Zend_Mail_Part_Interface
jump to top

Extends from: RecursiveIterator
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mail
subpackage: Storage
Methods: isMultipart; getContent; getSize; getPart; countParts; getHeaders; getHeader; getHeaderField; __get; __toString

Description

Methods

__get
jump to class

__get(
          string $name
          )
        
        :
        string

Getter for mail headers - name is matched in lowercase

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

Arguments

$name: string
header name

Output

string: value of header

Details

visibility: public
final: false
static: false
see: Zend_Mail_Part::getHeader()
throws

__toString
jump to class

__toString(
          
          )
        
        :
        string

magic method to get content of part

Output

string: content

Details

visibility: public
final: false
static: false

countParts
jump to class

countParts(
          
          )
        
        :
        int

Count parts of a multipart part

Output

int: number of sub-parts

Details

visibility: public
final: false
static: false

getContent
jump to class

getContent(
          
          )
        
        :
        string

Body of part

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

Output

string: body

Details

visibility: public
final: false
static: false
throws

getHeader
jump to class

getHeader(
          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).

Arguments

$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'

Output

string|array: value of header in wanted or internal format

Details

visibility: public
final: false
static: false
throws

getHeaderField
jump to class

getHeaderField(
          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.

Arguments

$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

Output

string|array: wanted part or all parts as array($firstName => firstPart, partname => value)

Details

visibility: public
final: false
static: false
throws: Zend_Mail_Exception

getHeaders
jump to class

getHeaders(
          
          )
        
        :
        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.

Output

array: headers as array(name => value)

Details

visibility: public
final: false
static: false

getPart
jump to class

getPart(
          int $num
          )
        
        :
        Zend_Mail_Part

Get part of multipart message

Arguments

$num: int
number of part starting with 1 for first part

Output

Zend_Mail_Part: wanted part

Details

visibility: public
final: false
static: false
throws

getSize
jump to class

getSize(
          
          )
        
        :
        int

Return size of part

Output

int: size

Details

visibility: public
final: false
static: false

isMultipart
jump to class

isMultipart(
          
          )
        
        :
        bool

Check if part is a multipart message

Output

bool: if part is multipart

Details

visibility: public
final: false
static: false

API Documentation

Mail/Part/Interface.php

Description

Zend_Mail_Part_Interfacejump to top

Description

Methods

__getjump to class

Arguments

Output

Details

__toStringjump to class

Output

Details

countPartsjump to class

Output

Details

getContentjump to class

Output

Details

getHeaderjump to class

Arguments

Output

Details

getHeaderFieldjump to class

Arguments

Output

Details

getHeadersjump to class

Output

Details

getPartjump to class

Arguments

Output

Details

getSizejump to class

Output

Details

isMultipartjump to class

Output

Details

Zend_Mail_Part_Interface
jump to top

__get
jump to class

__toString
jump to class

countParts
jump to class

getContent
jump to class

getHeader
jump to class

getHeaderField
jump to class

getHeaders
jump to class

getPart
jump to class

getSize
jump to class

isMultipart
jump to class