Mail/Part/Interface.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_Mail  
    Subpackage
    Storage  
    Version
    $Id$  

    \Zend_Mail_Part_Interface
    jump to top

    Package: Zend_Mail\Storage
    Parent(s)
    \RecursiveIterator
    Category
    Zend  
    Copyright
    Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

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

    header name

    Returns
    TypeDescription
    stringvalue of header
    Throws
    ExceptionDescription
    \Zend_Mail_Exception
    Details
    See
     
    methodpublic__toString() : string

    magic method to get content of part

    Returns
    TypeDescription
    stringcontent
    methodpubliccountParts() : int

    Count parts of a multipart part

    Returns
    TypeDescription
    intnumber 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
    TypeDescription
    stringbody
    Throws
    ExceptionDescription
    \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
    NameTypeDescription
    $namestring

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

    $formatstring

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

    Returns
    TypeDescription
    string | arrayvalue of header in wanted or internal format
    Throws
    ExceptionDescription
    \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
    NameTypeDescription
    $namestring

    name of header, like in getHeader()

    $wantedPartstring

    the wanted part, default is first, if null an array with all parts is returned

    $firstNamestring

    key name for the first part

    Returns
    TypeDescription
    string | arraywanted part or all parts as array($firstName => firstPart, partname => value)
    Throws
    ExceptionDescription
    \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
    TypeDescription
    arrayheaders as array(name => value)
    methodpublicgetPart(int $num) : \Zend_Mail_Part

    Get part of multipart message

    Parameters
    NameTypeDescription
    $numint

    number of part starting with 1 for first part

    Returns
    TypeDescription
    \Zend_Mail_Partwanted part
    Throws
    ExceptionDescription
    \Zend_Mail_Exception
    methodpublicgetSize() : int

    Return size of part

    Returns
    TypeDescription
    intsize
    methodpublicisMultipart() : bool

    Check if part is a multipart message

    Returns
    TypeDescription
    boolif part is multipart
    Documentation was generated by phpDocumentor 2.2.0 .