| <?php |
| /** |
| * File containing the ezcMailParserSet interface |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| * @package Mail |
| * @version //autogen// |
| * @copyright Copyright (C) 2005-2010 eZ Systems AS. All rights reserved. |
| * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0 |
| */ |
| |
| /** |
| * Interface common to all parser sets. |
| * |
| * A parser set provides a simple interface to fetch mail data line by |
| * line from a set of mail. |
| * |
| * @package Mail |
| * @version //autogen// |
| */ |
| interface ezcMailParserSet |
| { |
| /** |
| * Returns one line of data from the current mail in the set |
| * including the ending linebreak. |
| * |
| * Null is returned if there is no current mail in the set or |
| * the end of the mail is reached, |
| * |
| * @return string |
| */ |
| public function getNextLine(); |
| |
| /** |
| * Moves the set to the next mail and returns true upon success. |
| * |
| * False is returned if there are no more mail in the set. |
| * |
| * @return bool |
| */ |
| public function nextMail(); |
| |
| /** |
| * Returns true if mail data is available for parsing. |
| * |
| * @return bool |
| */ |
| public function hasData(); |
| } |
| ?> |