Source of file PartInterface.php
Size: 3,621 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Mail/Storage/Part/PartInterface.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Mail\Storage\Part; use RecursiveIterator; interface PartInterface extends RecursiveIterator { /** * Check if part is a multipart message * * @return bool if part is multipart */ public function isMultipart(); /** * Body of part * * If part is multipart the raw content of this part with all sub parts is returned * * @return string body * @throws Exception\ExceptionInterface */ public function getContent(); /** * Return size of part * * @return int size */ public function getSize(); /** * Get part of multipart message * * @param int $num number of part starting with 1 for first part * @return PartInterface wanted part * @throws Exception\ExceptionInterface */ public function getPart($num); /** * Count parts of a multipart part * * @return int number of sub-parts */ public function countParts(); /** * 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. * * @return \Zend\Mail\Headers */ public function getHeaders(); /** * Get a header in specified 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\Mime::LINEEND as delim). * * @param string $name name of header, matches case-insensitive, but camel-case is replaced with dashes * @param string $format change type of return value to 'string' or 'array' * @return string|array|\Zend\Mail\Header\HeaderInterface|\ArrayIterator value of header in wanted or internal format * @throws Exception\ExceptionInterface */ public function getHeader($name, $format = null); /** * 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 an exception if the requested header does not exist. If * the specific header field does not exist, returns null. * * @param string $name name of header, like in getHeader() * @param string $wantedPart the wanted part, default is first, if null an array with all parts is returned * @param string $firstName key name for the first part * @return string|array wanted part or all parts as array($firstName => firstPart, partname => value) * @throws Exception\ExceptionInterface */ public function getHeaderField($name, $wantedPart = '0', $firstName = '0'); /** * Getter for mail headers - name is matched in lowercase * * This getter is short for PartInterface::getHeader($name, 'string') * * @see PartInterface::getHeader() * * @param string $name header name * @return string value of header * @throws Exception\ExceptionInterface */ public function __get($name); /** * magic method to get content of part * * @return string content */ public function __toString(); } |