Added feature #15998: Create a new API to send mails based on SwiftMailer to replace...
[Packages/TYPO3.CMS.git] / typo3 / contrib / swiftmailer / classes / Swift / OutputByteStream.php
1 <?php
2
3 /*
4 * This file is part of SwiftMailer.
5 * (c) 2004-2009 Chris Corbyn
6 *
7 * For the full copyright and license information, please view the LICENSE
8 * file that was distributed with this source code.
9 */
10
11 /**
12 * An abstract means of reading data.
13 * Classes implementing this interface may use a subsystem which requires less
14 * memory than working with large strings of data.
15 * @package Swift
16 * @subpackage ByteStream
17 * @author Chris Corbyn
18 */
19 interface Swift_OutputByteStream
20 {
21
22 /**
23 * Reads $length bytes from the stream into a string and moves the pointer
24 * through the stream by $length. If less bytes exist than are requested the
25 * remaining bytes are given instead. If no bytes are remaining at all, boolean
26 * false is returned.
27 * @param int $length
28 * @return string
29 * @throws Swift_IoException
30 */
31 public function read($length);
32
33 /**
34 * Move the internal read pointer to $byteOffset in the stream.
35 * @param int $byteOffset
36 * @return boolean
37 * @throws Swift_IoException
38 */
39 public function setReadPointer($byteOffset);
40
41 }